Commit Graph

11 Commits

Author SHA1 Message Date
Kevin O'Connor bd0185cf75 docs: Don't use section-index plugin during klipper3d.org site generation
The section-index plugin can cause some confusing navigation.  Use the
simpler site navigation for now.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-08-17 19:39:23 -04:00
Kevin O'Connor 3176150050 mkdocs_hooks: Improve check for not in a list
Look for lines that don't start with a list and don't start with a
space to check for the end of a list.  This fixes the rendering of the
list in BLTouch.md .

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-08-02 16:14:54 -04:00
Kevin O'Connor b8f6b90467 mkdocs_hooks: Add some comments to the script
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-08-02 15:48:51 -04:00
Kevin O'Connor b837a344c1 _klipper3d: Add additional comments to mkdocs.yml
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-08-02 14:05:25 -04:00
Damien be122411b5 klipper3d: links to anchors not working with Safari
Solves issue #4538

Signed-off-by: Damien Martin <damlobster@gmail.com>
2021-07-28 09:26:08 -04:00
Kevin O'Connor a17c2ae397 _klipper3d: Set use_directory_urls to False
Restore old link behavior - each document file will have a single html
file ending in the ".html" suffix.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-07-27 18:58:08 -04:00
Kevin O'Connor ba16c0f1aa _klipper3d: Move mkdocs.yml to docs/_klipper3d
Reported by @damlobster .

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-07-27 17:10:59 -04:00
Kevin O'Connor 9c6b4d1bf4 _klipper3d: Add comments to files in this directory
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-07-27 13:49:06 -04:00
Kevin O'Connor bca64895e4 _klipper3d: Add trailing newline to extra.css
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-07-27 13:34:40 -04:00
Damien Martin afca515e2c docs: make mkdocs_hooks.transform more robust
- Keeps the markdown inside the code blocks as is
- Logs the modified lines (mkdocs serve —verbose)

Signed-off-by: Damien Martin <damlobster@gmail.com>
2021-07-27 13:15:25 -04:00
Damien ea802aa91e docs: Setup mkdocs with mkdocs-material theme
This changes the framework used to generate the klipper3d site.

Signed-off-by: Damien Martin <damlobster@gmail.com>
2021-07-27 13:15:25 -04:00