Skip to content

Commit e25dda0

Browse files
committed
first commit
0 parents  commit e25dda0

File tree

1,499 files changed

+417691
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,499 files changed

+417691
-0
lines changed
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: Update Gallery
2+
3+
on:
4+
push:
5+
paths:
6+
- 'docs/**'
7+
- 'generate-projects.js'
8+
workflow_dispatch:
9+
10+
jobs:
11+
update:
12+
runs-on: ubuntu-latest
13+
14+
steps:
15+
- name: Checkout repository
16+
uses: actions/checkout@v4
17+
18+
- name: Setup Node.js
19+
uses: actions/setup-node@v4
20+
with:
21+
node-version: '20'
22+
23+
- name: Generate projects.json
24+
run: node generate-projects.js
25+
26+
- name: Check for changes
27+
id: git-check
28+
run: |
29+
git diff --exit-code projects.json || echo "changed=true" >> $GITHUB_OUTPUT
30+
31+
- name: Commit and push changes
32+
if: steps.git-check.outputs.changed == 'true'
33+
run: |
34+
git config --local user.email "github-actions[bot]@users.noreply.github.com"
35+
git config --local user.name "github-actions[bot]"
36+
git add projects.json
37+
git commit -m "🤖 Auto-update projects.json [skip ci]"
38+
git push

.gitignore

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Node
2+
node_modules/
3+
package-lock.json
4+
5+
# OS
6+
.DS_Store
7+
Thumbs.db
8+
9+
# IDE
10+
.vscode/
11+
.idea/
12+
*.swp
13+
*.swo
14+
15+
# Logs
16+
*.log
17+
npm-debug.log*
18+
19+
# Temporary files
20+
*.tmp
21+
.cache/

README.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# CodeWiki Demo Gallery
2+
3+
**Live documentation showcase for projects documented with CodeWiki**
4+
5+
This repository hosts a static GitHub Pages site that displays documentation generated by [CodeWiki](https://github.com/FSoft-AI4Code/CodeWiki.git) for multiple open-source projects.
6+
7+
[![GitHub Pages](https://img.shields.io/badge/demo-live-brightgreen)](https://yourusername.github.io/codewiki-demo)
8+
9+
---
10+
11+
## 📁 Directory Structure
12+
13+
```
14+
codewiki-demo/
15+
├── index.html # Project gallery page
16+
├── viewer.html # Documentation viewer
17+
├── generate-projects.js # Auto-generates projects.json
18+
├── projects.json # Project metadata (auto-generated)
19+
├── docs/ # Documentation folders
20+
│ ├── owner--repo-docs/
21+
│ │ ├── overview.md
22+
│ │ ├── module_tree.json
23+
│ │ ├── metadata.json
24+
│ │ └── *.md
25+
│ └── ...
26+
└── README.md
27+
```
28+
29+
---
30+
31+
## 🔧 Adding New Documentation
32+
33+
Adding new project documentation is automatic:
34+
35+
1. **Copy new docs folder:**
36+
```bash
37+
cp -r /path/to/CodeWiki/output/docs/new-project-docs ./docs/
38+
```
39+
40+
2. **Regenerate index:**
41+
```bash
42+
node generate-projects.js
43+
```
44+
45+
3. **Commit and push** (if using GitHub Pages)
46+
47+
The new project will automatically appear in the gallery!
48+

0 commit comments

Comments
 (0)