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:
node generate-projects.js
-
Commit and push (if using GitHub Pages)
The new project will automatically appear in the gallery!