Giter Club home page Giter Club logo

1remote.github.io's Introduction

OneRemote Documentation

The documentation is created using the mm-docs documentation bundle.

Prerequisites

  • Docker installation.
    • For Windows Desktop use: cinst docker-desktop
  • PowerShell (optional)
    • Invoke-Build module
      • or use included ./Invoke-Build.ps1 script in the repository root

Usage

Within PowerShell use Invoke-Build (ib):

Command Description
ib Build Build static site
ib Run Serve static site with live reload

Otherwise, run appropriate docker commands:

export image=majkinetor/mm-docs
export aPort=8888

#build
docker run --rm -v $PWD:/docs8 $image mkdocs build

#serve
docker run --rm -v $PWD:/docs --name docs-$aPort --detach -p $aPort:$aPort $image mkdocs serve --dev-addr 0.0.0.0:$aPort

After building it, static site is available at source\site directory and it can be served with any kind of web server.

Adding documents

  • Add new markdown somewhere in the source\docs directory.
  • To be visible in navigation, add to source\mkdocs.yml nav section, otherwise, the page is available via direct link
  • Add footer, header, abbreviations etc. in source\inc folder
  • Add python function and modules in source\main.py
  • Override specific mkdocs material theme partials in source\overrides
  • Configure PDF and single page stuff in source\pdf
  • Configure extra CSS in docs\_css\extra.css

1remote.github.io's People

Contributors

majkinetor avatar vshawn avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

1remote.github.io's Issues

Create multilanguage setup

mkdocs-material supports language selector.

I know @VShawn that you like that, so I can add it for you.

My personal opinion is to not get involved into that, and just use English. I definitely don't want to create Serbian docs. App translation is OK on the other hand, because it doesn't require that much work.

Creating and maintaining technical docs on the other hand is hard and continuous work, while we do this for fun and no profit. Browsers do automatic translate which is really good nowdays, and you can't really make all different language docs follow the same quality and completeness.

But if you really want it, I will add Chinese for you. Just let me know.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.