Skip to content

Latest commit

Β 

History

History
48 lines (34 loc) Β· 1.32 KB

File metadata and controls

48 lines (34 loc) Β· 1.32 KB

CodeWiki Demo Gallery

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.

GitHub Pages


πŸ“ Directory Structure

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 Documentation

Adding new project documentation is automatic:

  1. Copy new docs folder:

    cp -r /path/to/CodeWiki/output/docs/new-project-docs ./docs/
  2. Regenerate index:

    python generate-projects.py
  3. Commit and push (if using GitHub Pages)

The new project will automatically appear in the gallery!