https://github.com/1remote/1remote.github.io

1Remote Documentation
https://github.com/1remote/1remote.github.io

documentation mm-docs

Last synced: 2 months ago
JSON representation

1Remote Documentation

• Host: GitHub
• URL: https://github.com/1remote/1remote.github.io
• Owner: 1Remote
• Created: 2022-05-14T13:34:23.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-14T12:18:24.000Z (2 months ago)
• Last Synced: 2024-11-14T13:24:45.258Z (2 months ago)
• Topics: documentation, mm-docs
• Language: PowerShell
• Homepage: https://1remote.github.io/
• Size: 6.07 MB
• Stars: 10
• Watchers: 3
• Forks: 18
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# OneRemote Documentation

The documentation is created using the [mm-docs](https://github.com/majkinetor/mm-docs) documentation bundle.

## Prerequisites

- Docker installation.

  - For Windows Desktop use: `cinst docker-desktop`

- PowerShell (optional)

  - [Invoke-Build](https://www.powershellgallery.com/packages/InvokeBuild) 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:

```sh

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`