Skip to content

Commit

Permalink
feat: re-expose mkdocs as .#docs.mkdocs
Browse files Browse the repository at this point in the history
    nix run .#docs.mkdocs serve
  • Loading branch information
zimbatm committed Aug 1, 2024
1 parent 57b2332 commit 2ae5be6
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 15 deletions.
2 changes: 2 additions & 0 deletions docs/.pages
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
nav:
- index.md
6 changes: 1 addition & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -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
Expand Down
2 changes: 2 additions & 0 deletions flake.nix
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@
installPhase = ''
mv site $out
'';

passthru.mkdocs = self.packages.${pkgs.system}.default;
};
});

Expand Down
10 changes: 0 additions & 10 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

0 comments on commit 2ae5be6

Please sign in to comment.