|
1 |
| -# MM-DOCS Template |
2 |
| - |
3 |
| -[](https://ci.appveyor.com/project/majkinetor/mm-docs-template) |
4 |
| -[](#) |
5 |
| -[](#) |
6 |
| -[VIEW DEMO](https://majkinetor.github.io/mm-docs-template) |
7 |
| - |
8 |
| -This project is used to produce all forms of documentation for the service using Markdown and other repository friendly markup languages. |
| 1 | +# OneRemote Documentation |
9 | 2 |
|
10 | 3 | The documentation is created using the [mm-docs](https://github.com/majkinetor/mm-docs) documentation bundle.
|
11 | 4 |
|
12 |
| -View how compiled static site looks like on [demo site](https://majkinetor.github.io/mm-docs-template) or grab generated [artifact](https://ci.appveyor.com/project/majkinetor/mm-docs-template/build/artifacts). Check out [pdf export](https://majkinetor.github.io/mm-docs-template/docs.pdf) of [single demo page](https://majkinetor.github.io/mm-docs-template/demo). |
13 |
| - |
14 |
| -See entire docs as a [single page](https://majkinetor.github.io/mm-docs-template/print_page/) and/or [download](https://majkinetor.github.io/mm-docs-template/download/) it. |
15 |
| - |
16 |
| -## Features |
17 |
| - |
18 |
| -- Documentation in Markdown, HTML, PlantUML, MatJax |
19 |
| -- Beautiful responsive design using the [material](https://squidfunk.github.io/mkdocs-material) theme |
20 |
| -- Navigational bar, TOC, color themes, go-to-top, search and various rich presentation functionalities |
21 |
| -- Custom includables that can be imported in any page: footer, header, abbreviations etc. |
22 |
| -- Variables, Python macros and jinja templates |
23 |
| -- Multilanguage support |
24 |
| -- Keep documentation for multiple user groups in the same project and build only specific one |
25 |
| -- Fast PDF export and single page documentation site |
26 |
| -- Bad link checker for internal and external links |
27 |
| -- Metainformation for every page - last git modification date, source file, authors, etc. |
28 |
| -- GitLab/GitHub repository connection for editing within a browser |
29 |
| -- Automated AppVeyor build and deploy to GitHub pages using Ubuntu image |
30 |
| -- Live reload during editing |
31 |
| -- Cross platform for hosting and development with convenient optional PowerShell task system |
32 |
| - |
33 | 5 | ## Prerequisites
|
34 | 6 |
|
35 | 7 | - Docker installation.
|
|
0 commit comments