diff --git a/docs/.pages b/docs/.pages new file mode 100644 index 0000000..be30bf4 --- /dev/null +++ b/docs/.pages @@ -0,0 +1,6 @@ +nav: + - index.md + - first-steps.md + - setup.md + - uploading.md + - ... \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 42b7f9b..0645496 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,7 +1,7 @@ # Overview This documentation is divided into several section for readability and maintainability. -You can skip between them at any time using the navigation on the left. +You can skip between them at any time using the sidebar on the left. ## Sections diff --git a/docs/setup.md b/docs/setup.md index 9c86a25..bcf079f 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -16,6 +16,7 @@ git clone https://github.com/SomeAspy/ChromeBookEnroller cd ChromeBookEnroller git branch -r ``` + Switch to the branch closest to your ChromeBook's version. --- diff --git a/docs/uploading.md b/docs/uploading.md new file mode 100644 index 0000000..e69de29 diff --git a/mkdocs.yml b/mkdocs.yml index 78334af..1af31b2 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,7 +1,7 @@ -# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json site_name: ChromeBookEnroller site_url: https://cbe.github.aspy.dev repo_url: https://github.com/SomeAspy/ChromeBookEnroller +edit_uri: edit/docs/docs copyright: Copyright © 2024 Aiden B. (SomeAspy) theme: name: material @@ -15,11 +15,15 @@ theme: - search.share - navigation.instant - navigation.tracking + - navigation.footer - content.code.copy - content.action.view + - content.action.edit + - toc.integrate plugins: - search + - awesome-pages markdown_extensions: - admonition diff --git a/requirements.txt b/requirements.txt index d4f69fe..c175064 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,5 @@ babel==2.16.0 +bracex==2.5 certifi==2024.7.4 charset-normalizer==3.3.2 click==8.1.7 @@ -10,9 +11,11 @@ Markdown==3.6 MarkupSafe==2.1.5 mergedeep==1.3.4 mkdocs==1.6.0 +mkdocs-awesome-pages-plugin==2.9.3 mkdocs-get-deps==0.2.0 mkdocs-material==9.5.31 mkdocs-material-extensions==1.3.1 +natsort==8.4.0 packaging==24.1 paginate==0.5.6 pathspec==0.12.1 @@ -27,3 +30,4 @@ requests==2.32.3 six==1.16.0 urllib3==2.2.2 watchdog==4.0.2 +wcmatch==9.0