diff --git a/docs/.pages b/docs/.pages new file mode 100644 index 0000000..35fd5a1 --- /dev/null +++ b/docs/.pages @@ -0,0 +1,2 @@ +nav: + - index.md diff --git a/docs/index.md b/docs/index.md index 4b2e334..9191c2f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,5 @@ # Numtide Material for MkDocs base repo - For full documentation visit [mkdocs-material](https://squidfunk.github.io/mkdocs-material/getting-started/). here are the base steps: @@ -20,17 +19,14 @@ If you have docs already jump to step 4. Go to the root directory of your cloned project and run mkdocs. This will set up docs folder, index.md and mkdocs.yaml file (note the fullstop) - + `mkdocs new .` This will create the following structure: ├─ docs/ - └─ index.md - └─ ** add your .md files here ! - └─ mkdocs.yml ** make sure your .md files are all in the docs folder diff --git a/flake.nix b/flake.nix index d8a2e2c..14ec621 100644 --- a/flake.nix +++ b/flake.nix @@ -53,6 +53,8 @@ installPhase = '' mv site $out ''; + + passthru.mkdocs = self.packages.${pkgs.system}.default; }; }); diff --git a/mkdocs.yml b/mkdocs.yml index 7725aef..81f48ae 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,8 +2,6 @@ INHERIT: !ENV MKDOCS_NUMTIDE_THEME ### Site metadata ### - - ## - This will be the name displayed in docs header site_name: Numtide custom docs ## - change this according to the relevant Numtide repo description @@ -14,11 +12,3 @@ site_url: https://numtide.github.io/mkdocs-numtide repo_url: https://github.com/numtide/mkdocs-numtide repo_name: 'numtide/mkdocs-numtide' edit_uri: edit/main/docs - -### Build settings ### - -## - Set your docs navigation structure here -## - this will determine which .md files are shown and where they appear in the header and sidebar navigation -nav: - - About the project: index.md - ## - See the nav section in this working example - https://github.com/numtide/treefmt/blob/main/mkdocs.yml