wiki-sync

Wiki Sync

Organize research notes into a structured wiki knowledge base.

Wiki Conventions

• Slugs: lowercase kebab-case (protein-folding, hypothesis-1)
• Wikilinks: [[slug]] for internal links, [[slug|Display Text]] for custom labels
• Index: always maintain a index.md with a table of all pages
• One concept per page: each page should focus on a single entity, concept, or topic
• Sources section: every page ends with a ## Sources section listing where the info came from

Workflow

1. Audit existing notes — list all files, identify what already has wiki structure
2. Identify concepts — extract key entities, topics, and relationships from unstructured notes
3. Create/update pages — one page per concept, with cross-links
4. Build index — generate or update index.md
5. Report — list new pages created, pages updated, links added

Page Template

# [Page Title]

[1–2 sentence summary of this concept]

## Overview
[Detailed content about this concept]

## Related Concepts
- [[related-slug-1]] — [brief description of relationship]
- [[related-slug-2]] — [brief description of relationship]

## Sources
- [Source name/file]
- [Source URL if applicable]

*Last updated: [date]*

Index Template

# Wiki Index

> Auto-maintained index of all wiki pages.

| Page | Summary | Updated |
|------|---------|---------|
| [[slug-1]] Page Title | One-line summary | YYYY-MM-DD |
| [[slug-2]] Page Title | One-line summary | YYYY-MM-DD |

Configuration

Override defaults by adding a wiki-sync.config.md file in your notes directory:

# Wiki Sync Config

maxPages: 20
outputDir: wiki/
indexFile: index.md
language: en

Option	Default	Description
maxPages	8	Max pages created per sync run. Increase for large note collections.
outputDir	. (same dir as notes)	Subdirectory to write wiki pages into
indexFile	index.md	Filename for the auto-generated index
language	en	Output language for generated text (en, ko, ja, etc.)

If no config file is present, all defaults apply.

Rules

• Default max 8 pages per sync run — override with maxPages in config (avoid overwhelming the user)
• Prefer updating existing pages over creating new ones for incremental syncs
• Never delete existing content — append or update sections
• Always rebuild the index after adding pages
• Respect outputDir if set in config — write all new pages there