flox / floxdocs

Curated Flox Documentation
https://flox.dev/docs/
1 stars 1 forks source link

flox documentation

Live at: flox.dev/docs.

Usage

$ flox activate
✅ You are now using the environment 'floxdocs'.

λ (floxdocs) $ flox services start mkdocs
✅ Service 'mkdocs' started.

Once mkdocs service started you can preview the documentation at https://127.0.0.1:8000.

Guidelines

The documentation should follow the divio philosophy https://documentation.divio.com/ with four clearly distinct approaches. A short summary:

External link checking

You can run a check for external link breakage with this command

$ flox activate -- ./check_links.sh

Update mkdocs-material-insiders archive

$ git clone https://github.com/squidfunk/mkdocs-material-insiders
$ python -m env env
$ ./env/bin/pip install --upgrade build twine
$ ./env/bin/python -m build
$ cp dist/mkdocs_material-*.tar.gz path/to/floxdocs