- Notifications
You must be signed in to change notification settings - Fork43
FreeTAKServer documentation for end users
License
FreeTAKTeam/FreeTAKServer-User-Docs
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
FreeTAKServer documentation for end users
https://freetakteam.github.io/FreeTAKServer-User-Docs/
The documentation uses theawesome-pages
plugin which allows afiner control of the document navigation.The official documentation forawesome-pages
is located in theproject repo.
In short, one may create a.pages
file with in the directory hierarchyto manipulate how the navigation structure is created.This file should contain thenav:
structure for just that directory.If the.pages
file does not existthenmkdocs
will generate the navigation according to its internal rules.Generally, a.pages
should be provided and not fall to the internal rules.
This plugin won't do anything if themkdocs.yml
defines anav
orpages
entry.
The documentation uses themike
plugin to provide support for multiple versions.The official documentation formike
is located in theproject repo.
Use ofmike
is not yet fully enabled.Advice as to its proper use is appreciated.
The documentation uses thesection-index
plugin which enables clickable sections leading to an index page.The official documentation forsection-index
is located in theproject repo.
The documentation uses thesearch
built in plugin which allows your users to search your documentation.The official documentation forsearch
is located in theproject repo.
The documentation uses thepdf-export
plugin which constructs a PDF file of the documentation.The official documentation forpdf-export
is located in theproject repo.
This only happens if theENABLE_PDF_EXPORT
environment variable it true.
The documentation uses themarkdown-include
plugin which constructs a PDF file of the documentation.The official documentation formarkdown-include
is located in theproject repo.
This reduces errors when text is to be injected into the document.For example, here is an excerpt from the LICENSE file.
{!LICENSE!lines=1 3 8-10 2}
The documentation uses theattr_list
extension whichadds a syntax to define attributes on the various HTML elements in markdown’s output.The official documentation forattr_list
is located in theproject repo.
Some uses:
- resizing images
- associating classes with elements
The documentation uses Mermaid2 to make network-deployment-diagrams.
The documentation uses PlantUML to make network-deployment-diagrams.https://github.com/quantorconsulting/mkdocs_build_plantumlThis tooling supports more of C4 and UML.
About
FreeTAKServer documentation for end users