This is a VSCode documentation preview extension, focused on providing developers with a convenient document browsing experience.
- 📁 Automatically parse Markdown documents in projects
- 📑 Generate clear document directory structure
- 🔍 Quickly locate and browse document content
- 🎯 Support multiple document format recognition
- Development Language: TypeScript
- Runtime Environment: VSCode Extension
- Core Functionality: Document parsing and directory generation
- Complexity Issues: The Markdown ecosystem contains numerous special tags and extended syntax (such as GitHub Flavored Markdown, various plugin syntaxes, etc.), and full compatibility would require significant development effort
- Focus on Core Value: The core value of this project lies in providing efficient document directory navigation, not content rendering
- Do One Thing Well: Focus on parsing and displaying document directories, making this functionality perfect
- Coexist with Ecosystem: Fully leverage excellent tools already available in the VSCode ecosystem, rather than trying to replace them
- Rapid Iteration: Focusing on core functionality allows the project to iterate and optimize more quickly
If you need Markdown preview functionality, we recommend:
- Use VSCode's built-in Markdown preview (Shortcut:
Ctrl/Cmd + Shift + V) - Install professional Markdown preview plugins, such as Markdown Preview Enhanced
Contributions are welcome! If you're interested in Markdown parsing, feel free to submit PRs to enhance the preview functionality.