Markdown Catalog Viewer
This is a VS Code extension that previews .catalog.md files in the sidebar from the current workspace root directory.
Features
- Display the content of
.catalog.md files in the VS Code sidebar
- Real-time preview of Markdown formatted catalog content
- Automatically detect changes to
.catalog.md files and refresh the display
How to Use
- Create a file named
.catalog.md in your workspace root directory
- Write your catalog content in this file (supports standard Markdown syntax)
- Open the "MD Catalog" panel in the VS Code sidebar to view the preview
Example .catalog.md file
# Project Catalog
## Chapter 1
- [Introduction](https://github.com/Merlin-Xu-G/md-catalog-extension/blob/HEAD/docs/intro.md)
- [Quick Start](https://github.com/Merlin-Xu-G/md-catalog-extension/blob/HEAD/docs/quickstart.md)
## Chapter 2
- [Advanced Features](https://github.com/Merlin-Xu-G/md-catalog-extension/blob/HEAD/docs/advanced.md)
- [API Reference](https://github.com/Merlin-Xu-G/md-catalog-extension/blob/HEAD/docs/api.md)
## Appendix
- [FAQ](https://github.com/Merlin-Xu-G/md-catalog-extension/blob/HEAD/docs/faq.md)
- [Changelog](https://github.com/Merlin-Xu-G/md-catalog-extension/blob/HEAD/docs/changelog.md)
Notes
- The extension only looks for
.catalog.md files in the workspace root directory
- If the file is not found, the panel will display a prompt message
- Content will automatically update after the file is saved
| |
