Skip to content

Latest commit

 

History

History
42 lines (23 loc) · 892 Bytes

README.md

File metadata and controls

42 lines (23 loc) · 892 Bytes

HDTF TECHINCAL DOCS

the documentation for all features and stuff for hdtf

Setup Localy

To run the website localy and be abel to see what changed, you will need the next things

pre-requisites

  • python 3.x
  • mkdocs material
  • mkdocs material macros

run these commands inside a command line or terminal

pip install mkdocs-material

pip install mkdocs-macros-plugin

pip install mkdocs-glightbox

next cd into your clone of the repo and run the following command

mkdocs serve

MacOS & Linux

if you are on mac or linux you might not have the paths setup for mkdocs

so you might need to run the following command

python3 -m mkdocs serve

Final Notes

thank you for taking an interest in the development of Hunt Down the Freeman and its documentation

we appreciate all the help we can get!

made with ❤️ by @Nbc66