README.md

Converting Data Intended for Django into Markdown Files for GitHub

This little app was written to convert the Django-data for the DHRI's curriculum website into GitHub-ready markdown files.

Requirements

• Git
• Python 3.8

---

Running the Script

Clone the workshop

First, clone the desired workshop. In the following example, we will work with the python workshop. In your terminal, type:

$ git clone https://www.github.com/DHRI-Curriculum/python

Navigate into the newly cloned directory:

$ cd python

Update Submodule

Register the submodule with your git installation:

$ git submodule init

Make sure the submodule is up-to-date:

$ git submodule update

Run setup.py

Run the script using your locally installed version of Python 3. In this example, the python command is aliased to python3 already. You may need to write python3 instead of python here.

Note that the Python script needs to be run inside the workshop directory itself:

$ python localdjango/setup.py

This should result in a new README.md file and an accompanying sections directory with all the markdown files.

Note that this script also makes all the references to the images directory into a relative reference to ../images directory. You need to manually make sure that that's where the images for your lessons.md file lives.