jacobinwwey_obsidian-NotEMD/DOCUMENTATION_INDEX.md

Documentation Index

Complete index of all documentation in the obsidian-NotEMD repository.

Quick Navigation

Category	Document	Description
🎯 Getting Started	README.md	Main project overview and features
🎯 Getting Started	docs/README.md	Documentation hub
📊 Slidev Export	docs/STANDALONE_BUNDLE_FIX.md	Latest: Bug fix documentation (2026-06-16)
📊 Slidev Export	BUNDLE_SCRIPTS_README.md	Bundler scripts reference
📊 Slidev Export	.github/BUNDLE_EXPORT_GUIDE.md	Contributor guide
📊 Slidev Export	CHANGELOG_STANDALONE_BUNDLE.md	Version history
📊 Slidev Export	docs/SINGLE_FILE_BUNDLER.md	Architecture overview
📊 Slidev Export	docs/export/README.md	User-facing export guide
📊 Slidev Export	docs/dist/README.md	Build output reference

By Topic

Core Plugin Documentation

Main Documentation:

• README.md - Project overview, features, installation, usage
• docs/README.md - Documentation hub with links to all docs
• docs/faq.md - Frequently asked questions

Architecture & Design:

• docs/architecture.md - Plugin architecture (English)
• docs/architecture.zh-CN.md - Plugin architecture (简体中文)

Internationalization:

• docs/i18n/README.md - Language hub
• 30+ translated README files in repository root

Slidev Export Feature

Latest Documentation (2026-06-16):

• ⭐ docs/STANDALONE_BUNDLE_FIX.md - Export transformation bug fix
• BUNDLE_SCRIPTS_README.md - All bundler scripts explained
• .github/BUNDLE_EXPORT_GUIDE.md - Complete contributor guide
• CHANGELOG_STANDALONE_BUNDLE.md - Version history

Technical Documentation:

• docs/SINGLE_FILE_BUNDLER.md - Architecture and implementation
• docs/SLIDEV_SOLUTION.md - Server-script mode (alternative)
• docs/SLIDEV_HTML_FIX.md - Original problem analysis

User Documentation:

• docs/export/README.md - Export modes, usage, troubleshooting
• docs/dist/README.md - Build output directory reference

Development & Planning

Maintainer Guides:

• docs/maintainer/release-workflow.md - Release process
• docs/releases/1.8.2.md - Release notes

Planning Documents:

• docs/brainstorms/ - Feature planning and decisions
• docs/superpowers/plans/ - Roadmaps and phase plans

Technical Docs:

• docs/chapter-split-toc.md - Chapter splitting feature

By Audience

For End Users

Start Here:

1. README.md - Overview and quick start
2. docs/faq.md - Common questions
3. docs/export/README.md - Slidev export guide

Troubleshooting:

• Check FAQ first
• Review relevant troubleshooting sections in docs
• Open GitHub issue if needed

For Contributors

Start Here:

1. docs/README.md - Documentation hub
2. .github/BUNDLE_EXPORT_GUIDE.md - Slidev bundler contribution guide
3. docs/architecture.md - Plugin architecture

Development:

• BUNDLE_SCRIPTS_README.md - Bundler scripts
• docs/maintainer/release-workflow.md - Release process

For Maintainers

Release Process:

1. docs/maintainer/release-workflow.md
2. CHANGELOG_STANDALONE_BUNDLE.md - Bundle versioning
3. docs/releases/ - Release notes

Quality Assurance:

• .github/BUNDLE_EXPORT_GUIDE.md - Testing checklists
• docs/dist/README.md - Build verification

Recent Updates (2026-06-16)

New Documentation

• ✨ docs/STANDALONE_BUNDLE_FIX.md - Detailed bug fix analysis
• ✨ BUNDLE_SCRIPTS_README.md - Script reference guide
• ✨ docs/export/README.md - User-facing export docs
• ✨ docs/dist/README.md - Build output reference
• ✨ CHANGELOG_STANDALONE_BUNDLE.md - Version history
• ✨ .github/BUNDLE_EXPORT_GUIDE.md - Contributor guide
• ✨ DOCUMENTATION_INDEX.md - This file

Updated Documentation

• 📝 docs/SINGLE_FILE_BUNDLER.md - Added bugfix section
• 📝 docs/README.md - Added slide export section
• 📝 test-bundle-FIXED.js - Added header comments

Document Types

Technical Specifications

• Architecture docs (.md with diagrams)
• API references
• Code structure explanations

User Guides

• Feature documentation
• Setup instructions
• Troubleshooting guides

Planning Documents

• Roadmaps (.en.md, .zh-CN.md)
• Brainstorms
• Decision records

Reference Material

• Script documentation
• Build output references
• Changelog files

File Naming Conventions

Language Suffixes:

• .md - English (default)
• .zh-CN.md - Simplified Chinese
• .en.md - Explicit English (in multilingual directories)

Special Prefixes:

• README.md - Directory overview
• CHANGELOG_*.md - Version history
• FAQ.md - Frequently asked questions

Document Locations:

• docs/ - Main documentation
• .github/ - GitHub-specific docs
• Root - Project-level docs

Search Tips

Find by keyword:

# Search all markdown files
grep -r "keyword" --include="*.md"

# Search documentation only
grep -r "keyword" docs/ --include="*.md"

Find by topic:

# Slidev export docs
ls docs/*SLIDEV*.md docs/*BUNDLE*.md

# Planning docs
ls docs/brainstorms/*.md docs/superpowers/plans/*.md

# Maintainer docs
ls docs/maintainer/*.md docs/releases/*.md

Contributing to Documentation

Adding New Documentation

1. Choose location:

   • Feature docs → docs/
   • User guides → docs/export/, docs/dist/
   • Developer guides → .github/
   • Root for project-level docs

2. Follow naming conventions:

   • Use descriptive names
   • Add language suffix if not English
   • Use README.md for directory overviews

3. Update indexes:

   • Add entry to this file
   • Add link in docs/README.md if relevant
   • Update parent directory README

4. Include metadata:

   • Last updated date
   • Version if applicable
   • Related documents section

Updating Existing Documentation

1. Check all locations:

   • Main document
   • Related documents
   • Index files
   • Changelog if versioned

2. Maintain consistency:

   • Update cross-references
   • Keep formatting consistent
   • Update dates

3. Test links:

   • Verify all internal links work
   • Check external references
   • Validate code examples

Documentation Standards

Markdown Formatting

• Use ATX-style headers (#, ##, ###)
• Use fenced code blocks with language tags
• Include table of contents for long documents
• Use relative links for internal references

Code Examples

• Include language tag for syntax highlighting
• Add comments explaining non-obvious code
• Show expected output when relevant
• Test examples before committing

Structure

• Start with brief overview
• Include quick start if applicable
• Organize with clear sections
• End with related documents or resources

Maintenance

Regular Tasks

• Update "Last Updated" dates
• Verify links still work
• Check for outdated information
• Update version numbers

Archive Policy

• Keep old versions in docs/archive/ if needed
• Update links to archived content
• Add "Archived" notice to old docs

Translation Updates

• Coordinate updates across languages
• Prioritize English and Simplified Chinese
• Update translation status in language hub

Quick Links

Most Important:

• README.md - Start here
• docs/STANDALONE_BUNDLE_FIX.md - Latest fix docs
• .github/BUNDLE_EXPORT_GUIDE.md - Contributor guide

For Issues:

• GitHub Issues: https://github.com/Jacobinwwey/obsidian-NotEMD/issues
• Discord: https://discord.gg/qnGgsQ9W

---

Maintained by: NotEMD Documentation Team
Repository: https://github.com/Jacobinwwey/obsidian-NotEMD
Last Updated: 2026-06-16
Total Documents: 45+ (including translations)