Predelnik / Scripture

Documentation generation system for sanctuary/notes

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Scripture

Documentation generation system for Notes about Diablo 1 Game Engine (https://github.com/sanctuary/notes) inspired and partially based on https://github.com/libgit2/docurium

Additionally it can experimentally generate .IDC script to populate IDA database with data from notes.

Prerequisites

pip install -r requirements.txt

Usage

Regeneration

Copy extract.sh.sample as extract.sh and fix path to notes inside it. Then run extract.sh

Then copy the contents of the site directory to repo which is checked out to gh-pages branch and push manually, or also add it to extraction script.

If you wish to generate IDC script, path to it could be specified with --idc-path option

About

Documentation generation system for sanctuary/notes


Languages

Language:Python 32.2%Language:JavaScript 27.8%Language:CSS 20.2%Language:HTML 19.2%Language:Shell 0.5%