https://github.com/numtide/mkdocs-numtide
Our own mkdocs template, based on the material design
https://github.com/numtide/mkdocs-numtide
Last synced: about 1 year ago
JSON representation
Our own mkdocs template, based on the material design
- Host: GitHub
- URL: https://github.com/numtide/mkdocs-numtide
- Owner: numtide
- License: apache-2.0
- Created: 2023-02-28T09:27:30.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-06T14:28:40.000Z (almost 2 years ago)
- Last Synced: 2025-04-02T23:55:51.085Z (about 1 year ago)
- Language: Nix
- Size: 1.21 MB
- Stars: 3
- Watchers: 7
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mkdocs-numtide
Our own mkdocs template, based on the material design
## Demo
To see the docs go
here.
## Usage
The high-level is:
1. Import the flake
2. Use the default package as a mkdocs server in your devshell
3. Use `INHERIT: !ENV MKDOCS_NUMTIDE_THEME` in the mkdocs.yml
4. Call `mkdocs-numtide.lib.${system}.mkDocs { name, src }` to build the docs.
5. Copy the `./.github/workflows/gh-pages.yml` to the repo to publish the
docs to github pages.
6. Configure the repo to publish the `gh-pages` branch to GitHub pages.