This is a project which aims to document the casio OS partially https://bible.planet-casio.com/lailouezzz/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Lailouezzz f457a5fc90
More details
3 weeks ago
docs More details 3 weeks ago
.gitignore Adding .gitignore 3 weeks ago
README.md More details 3 weeks ago
macros_def.py First commit 3 weeks ago
mkdocs.yml First commit 3 weeks ago

README.md

Casio documentation project

This static website is available on the casio bible.

Description

macros_def.py is a python script who define some macros for simplify writing :

  • includecode(path, flavor) : it’s for include a file code example :
    {{ includecode("/path/to/file.cpp", "cpp") }}

  • includemd(path) : it’s for include over .md file (like #include in C) example :
    {{ includemd("/path/to/file.md") }}

  • downloadlink(contain, url) : it’s for create a download link example :
    {{ downloadlin("zip file here", "/path/to/file.zip") }}

mkdocs.yml is here for define how mkdocs build the static site.
Check the official site of mkdocs for more informations.

Dependencies

  • mkdocs for build the static site.
  • mkdocs-material is needed for beautiful CSS (pip install mkdocs-material).
  • mkdocs-macros-plugin is needed for use the macros (pip install mkdocs-macros-plugin).
  • mkdocs-pdf-export-plugin is needed for convert all .md in PDF format (mkdocs-pdf-export-plugin).
  • I think that’s all :)