Skip to content

Latest commit

 

History

7 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

docs

Aggregated documentation for the LilithSec pantheon, built with MkDocs + Material and published to GitHub Pages.

Each component's docs live in its own repo, under docs/. scripts/sync-docs.sh pulls each repo's docs/ into docs/<section>/ (shallow + sparse clone; all sources are public, so no auth is needed). On top of that this repo adds a landing page, the cross-cutting Pantheon map, and a hook (hooks/pantheon_links.py) that rewrites inter-component GitHub links into internal links.

Building locally

python -m venv .venv && . .venv/bin/activate
pip install -r requirements.txt
./scripts/sync-docs.sh   # pull the component docs into docs/<section>/
mkdocs serve             # http://127.0.0.1:8000

Re-run sync-docs.sh whenever the component docs change. The synced section dirs are git-ignored. CI runs the same two steps (see .github/workflows/deploy.yml).

The nav: in mkdocs.yml lists each section's pages explicitly. If a component adds or removes a doc, update its nav block to match (page titles come from each page's H1, so only paths are listed).

Where the docs actually live

Section Source repo Branch Notes
Lilith LilithSec/Lilith main
Lilu LilithSec/App-Lilu main
Baphomet VVelox/Baphomet main different org
Ereshkigal LilithSec/Ereshkigal main
Lamashtu LilithSec/Lamashtu main
Virani LilithSec/Virani main
Nisaba VVelox/Plugtools dev docs only on dev; rename to LilithSec/Nissaba pending
Allani LilithSec/Allani main

To wire in a new component, add it to the REPOS list in scripts/sync-docs.sh, add a nav block for its pages to mkdocs.yml, and (if it cross-links) an entry to hooks/pantheon_links.py.

About

LilithSec docs for general stuff

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages