Skip to content

replete/experiment-mkdocs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Documentation Project

Simple documentation site using MkDocs with PDF export support.

Setup

  • run python setup.py to creeta a venv and install deps

Usage

Just run:

  • Start dev server (runs mkdocs serve):

    python run.py
  • Build static site (runs mkdocs build, creates /site directory):

    python run.py build
  • Generate PDF (creates documentation.pdf in /site/pdf/):

    python run.py pdf

The script will automatically set up the virtual environment on first run. Built site will be in the site directory. PDFs will be in site/pdf/documentation.pdf.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages