Live documentation showcase for projects documented with CodeWiki
This repository hosts a static GitHub Pages site that displays documentation generated by CodeWiki for multiple open-source projects.
codewiki-demo/
βββ index.html # Project gallery page
βββ viewer.html # Documentation viewer
βββ generate-projects.js # Auto-generates projects.json
βββ projects.json # Project metadata (auto-generated)
βββ docs/ # Documentation folders
β βββ owner--repo-docs/
β β βββ overview.md
β β βββ module_tree.json
β β βββ metadata.json
β β βββ *.md
β βββ ...
βββ README.md
Adding new project documentation is automatic:
-
Copy new docs folder:
cp -r /path/to/CodeWiki/output/docs/new-project-docs ./docs/
-
Regenerate index:
python generate-projects.py
-
Commit and push (if using GitHub Pages)
The new project will automatically appear in the gallery!