Skip to content

tpbnick/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Welcome to Nick's Docs 📚

This is a place for documentation examples, programming notes, and projects.

If you are looking for Nick's Portfolio, please click here.

This technical documentation site is built with Material for MKDocs.

Getting Started

Install the following required packages:

  1. pip install mkdocs mkdocs-material mkdocs-minify-plugin mkdocs-glightbox

This installs:

  1. MKDocs
  2. MKDocs-Material
  3. MKDocs-Minify-Plugin
  4. MKDocs-GLightbox

How to Serve

Run mkdocs serve. This should startup a local server that updates on any saved change.

How to Build

Run mkdocs Build. This should create static HTML files inside the site directory.