Skip to content

FSoft-AI4Code/codewiki-demo

Repository files navigation

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:

    node generate-projects.js
  3. Commit and push (if using GitHub Pages)

The new project will automatically appear in the gallery!

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published