git @ Cat's Eye Technologies The-Glosscubator / master script / build_readmes
master

Tree @master (Download .tar.gz)

build_readmes

We have a collection of resources, formatted as Feedmark files (Markdown files with extra structure).

This Python program reads in all these files, collates them, and writes out combined files (READMEs).

Each entry has 1 or more topics. Each entry is in a file in a directory, and this establishes its "main topic". But the entry can also have a "topics:" key. If it does, this indicates it is in 2 or more topics.

The READMEs are rendered on a topic-by-topic basis. However, if an entry has more than one topic, it is included on each topic README that it has a topic for. In the topic READMEs which are not its "main" topic, it shows the "main" topic of the entry, as a link.

History of script / build_readmes @master git clone https://git.catseye.tc/The-Glosscubator/