You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Ethan Paul e193bc73fe Add initial raid card setup docs 6 months ago
docs Add initial raid card setup docs 6 months ago
.gitignore Update readme and add gitignore 9 months ago
LICENSE Initial commit 1 year ago
Pipfile Add pipfile and dependencies, update project layout 9 months ago
Pipfile.lock Add pipfile and dependencies, update project layout 9 months ago
README.md Fix formatting errors in readme 9 months ago
mkdocs.yml Rename images dir to img following standard practices 9 months ago

README.md

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.