https://github.com/drupol/mkdocs-template
https://github.com/drupol/mkdocs-template
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/drupol/mkdocs-template
- Owner: drupol
- Created: 2024-03-15T09:04:46.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-15T09:19:41.000Z (about 2 years ago)
- Last Synced: 2025-01-16T00:42:08.805Z (over 1 year ago)
- Language: Nix
- Size: 3.91 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# MKDocs with Nix
## Usage
To run a development server:
```sh
nix develop
mkdocs serve
```
To build the site:
```sh
nix build
```
The resulting HTML files will be in `./result`
## Direnv integration
This project uses [direnv](https://direnv.net/) to automatically load the Nix
environment when you `cd` into the project directory. To enable this, run:
```sh
direnv allow
```