Skip to content
This repository was archived by the owner on Jan 9, 2022. It is now read-only.

enpaul/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

omni-docs

ENP.One system and infrastructure documentation, written using MkDocs

building

  1. Install Pipenv
  2. Synchronize environment
  3. Build documentation
# Install pipenv
pip install pipenv --user
# Synchronize
pipenv sync
# Build docs
pipenv run mkdocs build

The docs are now located in the site/ directory and can be served as static HTML. See MkDocs deployment

editing

  1. Install Pipenv
  2. Synchronize environment, with development dependencies
  3. Run development server
# Install pipenv
pip install pipenv --user
# Synchronize, with dev deps
pipenv sync --dev
# Run dev server
pipenv run mkdocs serve

The development server is available at http://localhost:8000 and will automatically refresh with any changes made to the local files.

About

Homelab documentation - (mirror of https://vcs.enp.one/omni/omni-docs/)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published