Skip to content

figtools/figgy.docs

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Figgy Docs

Never change any files in the mkdocs-material/material directory. This directory is wiped & rebuilt when you run npm run build

To run locally, from the root project directory run:

mkdocs serve -v 

Then go to: http://localhost:8000/

To rebuild the theme stored in the mkdocs-material/ directory (which updates the splash page changes):

cd mkdocs-material/ then npm run build

This will update the mkdocs-material/material folder with the latest build. This folder is the doc's site will reference for the theme when building.

To update the theme and rebuild the project from the root directory run:

cd mkdocs-material && npm run build && cd ../ && mkdocs serve -v

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 39.5%
  • HTML 36.4%
  • SCSS 23.3%
  • Other 0.8%