hackforla / peopledepot

A project to setup a datastore for people and projects at HackforLA. The link below takes you to the code documentation
https://hackforla.github.io/peopledepot/
GNU General Public License v2.0
5 stars 24 forks source link

Set up mkdocs site in PD #166

Closed fyliu closed 6 months ago

fyliu commented 1 year ago

Overview

We need to convert our docs to use the mkdocs documentation generator. It will make it easier to work on documentation. This issue should be done as simply as possible without adding the bells and whistles.

Action Items

Resources/Instructions

fyliu commented 11 months ago

I've actually been working on this one and I created a docker config to build an image so our devs won't have to install mkdocs on their own machines. But I realized it can work for all the other teams using mkdocs at hfla, so I went to set up the docker-mkdocs repo for that purpose. I'm planning to finish that soon and then make our setup just download that image rather than build it ourselves.

This should be very fast once I come back to it.

Neecolaa commented 9 months ago
fyliu commented 7 months ago

I've been working on this and the current progress is this: https://fyliu.github.io/peopledepot/tools/mkdocs/

I also accidentally pushed the changes to hackforla/main for a short time before reverting that history. So the same docs are also hosted at https://hackforla.github.io/peopledepot/tools/mkdocs/