Skip to content

Latest commit

 

History

History
25 lines (16 loc) · 940 Bytes

README.md

File metadata and controls

25 lines (16 loc) · 940 Bytes

BenDeavor Wiki

This wiki is intended as my professional documentation page for various projects that I have worked on or will currently be working on.

Dependencies

This wiki uses python-poetry as a Python package manager.

This wiki is uses a static site generator mkdocs

Commands

  • mkdocs new [dir-name] - Create a new project.
  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.
  • mkdocs -h - Print help message and exit.

Project layout

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.

The Jupyter notebook and Python file page generator is a plugin for mkdocs called mkdocs-jupyter# benheim