search

D2Modders / D2-ReModded-Wiki

Public wiki for D2 ReModded: Road to Destruction
GNU Affero General Public License v3.0
0 stars 0 forks source link

Web page with section navigation for `Design Rationale` #3

Open pairofdocs opened 3 years ago

pairofdocs commented 3 years ago

Testing out a MkDocs rendering of the Design Rationale markdown https://github.com/D2Modders/D2-ReModded-Wiki/wiki/Design-rationale

mkdocs installation

pip install mkdocs mkdocs new wiki

edit the markdown files

then mkdocs gh-deploy to push the markdown files to github's gh-pages for the Wiki repo https://d2modders.github.io/D2-ReModded-Wiki/

comparisons

the wiki markdown doesn't have a nice navigation panel on the left:

https://github.com/D2Modders/D2-ReModded-Wiki/wiki/Design-rationale

mkdocs on githubpages has a nice navigation panel!

https://d2modders.github.io/D2-ReModded-Wiki/design-rationale/

pairofdocs commented 3 years ago

Some bells and whistles with themes https://github.com/mkdocs/mkdocs/wiki/MkDocs-Themes