From 39c57b3bbfdbc34873962b83257b546d3dadf22b Mon Sep 17 00:00:00 2001 From: Jonathan Fox Date: Mon, 25 Nov 2024 08:37:48 +0000 Subject: [PATCH] CI test --- docs/mkdocs.yml | 1 + docs/{ => pages}/css/extra.css | 0 docs/{ => pages}/developer/building.md | 0 docs/{ => pages}/developer/contributing.md | 0 .../getting_started/example_commands.md | 0 .../getting_started/example_use_case.md | 0 .../getting_started/getting_resources.md | 0 .../getting_started/getting_started.md | 0 .../getting_started/installation.md | 0 .../getting_started/supported_languages.md | 0 .../getting_started/using_the_tool.md | 0 docs/{ => pages}/index.md | 0 docs/pages/mkdocs.yml | 102 ++++++++++++++++++ .../reference/command_reference.md | 0 .../{ => pages}/reference/default_settings.md | 0 15 files changed, 103 insertions(+) rename docs/{ => pages}/css/extra.css (100%) rename docs/{ => pages}/developer/building.md (100%) rename docs/{ => pages}/developer/contributing.md (100%) rename docs/{ => pages}/getting_started/example_commands.md (100%) rename docs/{ => pages}/getting_started/example_use_case.md (100%) rename docs/{ => pages}/getting_started/getting_resources.md (100%) rename docs/{ => pages}/getting_started/getting_started.md (100%) rename docs/{ => pages}/getting_started/installation.md (100%) rename docs/{ => pages}/getting_started/supported_languages.md (100%) rename docs/{ => pages}/getting_started/using_the_tool.md (100%) rename docs/{ => pages}/index.md (100%) create mode 100644 docs/pages/mkdocs.yml rename docs/{ => pages}/reference/command_reference.md (100%) rename docs/{ => pages}/reference/default_settings.md (100%) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index f91efdb..e72d268 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -7,6 +7,7 @@ site_description: >- repo_url: https://github.com/jonathanfox5/gogadget repo_name: gogadget +docs_dir: pages copyright: Copyright © 2024 Jonathan Fox diff --git a/docs/css/extra.css b/docs/pages/css/extra.css similarity index 100% rename from docs/css/extra.css rename to docs/pages/css/extra.css diff --git a/docs/developer/building.md b/docs/pages/developer/building.md similarity index 100% rename from docs/developer/building.md rename to docs/pages/developer/building.md diff --git a/docs/developer/contributing.md b/docs/pages/developer/contributing.md similarity index 100% rename from docs/developer/contributing.md rename to docs/pages/developer/contributing.md diff --git a/docs/getting_started/example_commands.md b/docs/pages/getting_started/example_commands.md similarity index 100% rename from docs/getting_started/example_commands.md rename to docs/pages/getting_started/example_commands.md diff --git a/docs/getting_started/example_use_case.md b/docs/pages/getting_started/example_use_case.md similarity index 100% rename from docs/getting_started/example_use_case.md rename to docs/pages/getting_started/example_use_case.md diff --git a/docs/getting_started/getting_resources.md b/docs/pages/getting_started/getting_resources.md similarity index 100% rename from docs/getting_started/getting_resources.md rename to docs/pages/getting_started/getting_resources.md diff --git a/docs/getting_started/getting_started.md b/docs/pages/getting_started/getting_started.md similarity index 100% rename from docs/getting_started/getting_started.md rename to docs/pages/getting_started/getting_started.md diff --git a/docs/getting_started/installation.md b/docs/pages/getting_started/installation.md similarity index 100% rename from docs/getting_started/installation.md rename to docs/pages/getting_started/installation.md diff --git a/docs/getting_started/supported_languages.md b/docs/pages/getting_started/supported_languages.md similarity index 100% rename from docs/getting_started/supported_languages.md rename to docs/pages/getting_started/supported_languages.md diff --git a/docs/getting_started/using_the_tool.md b/docs/pages/getting_started/using_the_tool.md similarity index 100% rename from docs/getting_started/using_the_tool.md rename to docs/pages/getting_started/using_the_tool.md diff --git a/docs/index.md b/docs/pages/index.md similarity index 100% rename from docs/index.md rename to docs/pages/index.md diff --git a/docs/pages/mkdocs.yml b/docs/pages/mkdocs.yml new file mode 100644 index 0000000..f91efdb --- /dev/null +++ b/docs/pages/mkdocs.yml @@ -0,0 +1,102 @@ +site_name: gogadget +site_url: https://jonathanfox5.github.io/gogadget +site_author: Jonathan Fox +site_description: >- + User friendly toolkit for generating immersion language learning tools including + downloading media, generating subtitles and creating Anki decks. + +repo_url: https://github.com/jonathanfox5/gogadget +repo_name: gogadget + +copyright: Copyright © 2024 Jonathan Fox + +nav: + - Home: + - Overview: index.md + - Installation & Usage: + - Installation: getting_started/installation.md + - Using the Tool: getting_started/using_the_tool.md + - Example Commands: getting_started/example_commands.md + - "Example Use Case: Priming": getting_started/example_use_case.md + - Reference: + - Supported Languages: getting_started/supported_languages.md + - Getting dictionaries, word audio and exclude lists: getting_started/getting_resources.md + - Commands and Settings: + - Command Reference: reference/command_reference.md + - Default Settings: reference/default_settings.md + - Developer: + - Building: developer/building.md + - Contributing: developer/contributing.md + - Report a bug or request a feature (Github): https://github.com/jonathanfox5/gogadget/issues + - Getting Started: + - Overview: getting_started/getting_started.md + - Installation & Usage: + - Installation: getting_started/installation.md + - Using the Tool: getting_started/using_the_tool.md + - Example Commands: getting_started/example_commands.md + - "Example Use Case: Priming": getting_started/example_use_case.md + - Reference: + - Supported Languages: getting_started/supported_languages.md + - Getting dictionaries, word audio and exclude lists: getting_started/getting_resources.md + - Command Reference: reference/command_reference.md + - Default Settings: reference/default_settings.md + - Commands and Settings: + - Command Reference: reference/command_reference.md + - Default Settings: reference/default_settings.md + - Developer: + - Building: developer/building.md + - Contributing: developer/contributing.md + - Report a bug or request a feature (Github): https://github.com/jonathanfox5/gogadget/issues + + +theme: + name: material + palette: + primary: black + accent: indigo + scheme: slate + font: + text: Source Sans 3 + code: Source Code Pro + features: + - content.code.copy + - navigation.footer + - navigation.tabs + - navigation.tabs.sticky + - search.suggest + - toc.integrate + - toc.follow + + +markdown_extensions: + - pymdownx.highlight: + anchor_linenums: true + line_spans: __span + pygments_lang_class: true + - pymdownx.inlinehilite + - pymdownx.snippets + - pymdownx.superfences + - admonition + - pymdownx.details + - mdx_truly_sane_lists: + nested_indent: 2 + truly_sane: true + - attr_list + +plugins: + - glightbox + - search: + - minify: + minify_html: true + +extra_css: + - css/extra.css + +extra: + social: + - icon: fontawesome/brands/github + link: https://github.com/jonathanfox5/ + name: jonathanfox5 on Github + - icon: fontawesome/brands/youtube + link: https://www.youtube.com/@jonathanfox5634 + name: jonathanfox5 on YouTube \ No newline at end of file diff --git a/docs/reference/command_reference.md b/docs/pages/reference/command_reference.md similarity index 100% rename from docs/reference/command_reference.md rename to docs/pages/reference/command_reference.md diff --git a/docs/reference/default_settings.md b/docs/pages/reference/default_settings.md similarity index 100% rename from docs/reference/default_settings.md rename to docs/pages/reference/default_settings.md