From 7283a3eafdc1ca22d19e6387f0c2ce33131d8eb4 Mon Sep 17 00:00:00 2001 From: Vishesh 'ironeagle' Bangotra Date: Fri, 11 Sep 2026 05:38:06 +0530 Subject: [PATCH] docs: nest lib docs under docs/lib with lib-prefixed nav --- docforge.nav.yml | 27 ++++++++++-------- mkdocs.yml | 72 +++++++++++++++++++++++++----------------------- 2 files changed, 53 insertions(+), 46 deletions(-) diff --git a/docforge.nav.yml b/docforge.nav.yml index 20349e8..02d6c12 100644 --- a/docforge.nav.yml +++ b/docforge.nav.yml @@ -1,16 +1,19 @@ -home: index.md +home: lib/index.md groups: Core API: - - core/index.md - - core/content.md - - core/parser.md - - core/scraper.md + - lib/core/index.md + - lib/core/content.md + - lib/core/parser.md + - lib/core/scraper.md HTML Handling: - - html/index.md - - html/parser.md - - html/scraper.md + - lib/html/index.md + - lib/html/parser.md + - lib/html/scraper.md PDF Handling: - - pdf/index.md - - pdf/client.md - - pdf/parser.md - - pdf/scraper.md + - lib/pdf/index.md + - lib/pdf/client.md + - lib/pdf/parser.md + - lib/pdf/scraper.md +icon: + logo: material/book-open-page-variant + repo: fontawesome/brands/github \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 5a79b21..3588ef6 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -21,6 +21,31 @@ theme: - search.highlight - search.share - search.suggest + icon: + logo: material/book-open-page-variant + repo: fontawesome/brands/github +markdown_extensions: +- pymdownx.superfences +- pymdownx.inlinehilite +- pymdownx.snippets +- admonition +- pymdownx.details +- pymdownx.highlight: + linenums: true + anchor_linenums: true + line_spans: __span + pygments_lang_class: true +- pymdownx.tabbed: + alternate_style: true +- pymdownx.tasklist: + custom_checkbox: true +- tables +- footnotes +- pymdownx.caret +- pymdownx.tilde +- pymdownx.mark +extra_css: +- https://unpkg.com/dracula-prism/dist/css/dracula-prism.css plugins: - search - mkdocstrings: @@ -41,42 +66,21 @@ plugins: show_category_heading: true show_object_full_path: false show_symbol_type_heading: true -markdown_extensions: -- pymdownx.superfences -- pymdownx.inlinehilite -- pymdownx.snippets -- admonition -- pymdownx.details -- pymdownx.superfences -- pymdownx.highlight: - linenums: true - anchor_linenums: true - line_spans: __span - pygments_lang_class: true -- pymdownx.tabbed: - alternate_style: true -- pymdownx.tasklist: - custom_checkbox: true -- tables -- footnotes -- pymdownx.caret -- pymdownx.tilde -- pymdownx.mark site_name: omniread -docs_dir: docs/lib +docs_dir: docs nav: -- Home: index.md +- Home: lib/index.md - Core API: - - core/index.md - - core/content.md - - core/parser.md - - core/scraper.md + - lib/core/index.md + - lib/core/content.md + - lib/core/parser.md + - lib/core/scraper.md - HTML Handling: - - html/index.md - - html/parser.md - - html/scraper.md + - lib/html/index.md + - lib/html/parser.md + - lib/html/scraper.md - PDF Handling: - - pdf/index.md - - pdf/client.md - - pdf/parser.md - - pdf/scraper.md + - lib/pdf/index.md + - lib/pdf/client.md + - lib/pdf/parser.md + - lib/pdf/scraper.md