# yzhang-gh/vscode-markdown

**Attribution required: if you use, quote, or summarise this content, you must credit and link back to [awesome-repositories.com](https://awesome-repositories.com/repository/yzhang-gh-vscode-markdown).**

3,162 stars · 355 forks · TypeScript · mit

## Links

- GitHub: https://github.com/yzhang-gh/vscode-markdown
- Homepage: https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one
- awesome-repositories: https://awesome-repositories.com/repository/yzhang-gh-vscode-markdown.md

## Topics

`markdown` `vscode`

## Description

This is a VS Code extension that provides a suite of tools for editing, previewing, and managing Markdown documents. It integrates an authoring toolset, a link management system, and a rendering engine to support the creation of structured technical documentation and knowledge bases.

The project distinguishes itself through advanced reference handling and accessibility features, such as a system that automatically updates internal links when files or headers are renamed and an artificial intelligence tool for generating descriptive image alt text. It also supports the rendering of Mermaid diagrams and KaTeX math formulas within a real-time preview pane that accepts custom CSS styling.

The extension covers a broad range of capabilities including automated table of contents generation, GitHub Flavored Markdown table formatting, and path autocompletion for files and headers. It further provides tools for workspace-wide reference searching, local link validation, and the export of Markdown source files to styled HTML.

## Tags

### Development Tools & Productivity

- [Markdown Documentation Tools](https://awesome-repositories.com/f/development-tools-productivity/markdown-documentation-tools.md) — Provides a comprehensive toolset for authoring and organizing structured technical documentation in Markdown.
- [Document Structure Navigators](https://awesome-repositories.com/f/development-tools-productivity/documentation-navigation/document-structure-navigators.md) — Provides a hierarchical tree of headers in a side panel for browsing and jumping between document sections.
- [Markdown Previewers](https://awesome-repositories.com/f/development-tools-productivity/markdown-previewers.md) — Provides a real-time visual rendering of markdown source text with synchronized side-by-side scrolling. ([source](https://code.visualstudio.com/docs/languages/markdown))
- [Document Header Jumping](https://awesome-repositories.com/f/development-tools-productivity/navigation-shortcuts/document-header-jumping.md) — Allows users to jump to specific headers within the current file or across the workspace via a searchable list. ([source](https://code.visualstudio.com/docs/languages/markdown))
- [VS Code Extensions](https://awesome-repositories.com/f/development-tools-productivity/vs-code-extensions.md) — Integrates a full suite of markdown editing, previewing, and management tools directly into the VS Code editor.
- [Workspace Reference Tracking](https://awesome-repositories.com/f/development-tools-productivity/workspace-reference-tracking.md) — Maintains an index of all markdown links to automate updates when files or headers are renamed.
- [Custom Style Injection](https://awesome-repositories.com/f/development-tools-productivity/markdown-previewers/custom-style-injection.md) — Allows users to apply custom CSS stylesheets via URLs or local paths to style rendered previews. ([source](https://code.visualstudio.com/docs/languages/markdown))
- [Path Autocompletion Tools](https://awesome-repositories.com/f/development-tools-productivity/path-autocompletion-tools.md) — Offers intelligent path suggestions for files, images, and reference links while typing. ([source](https://cdn.jsdelivr.net/gh/yzhang-gh/vscode-markdown@master/README.md))
- [Header Path Completion](https://awesome-repositories.com/f/development-tools-productivity/path-autocompletion-tools/header-path-completion.md) — Suggests available files and headers while typing links to ensure accurate internal referencing. ([source](https://code.visualstudio.com/docs/languages/markdown))

### Part of an Awesome List

- [Automatic Reference Updaters](https://awesome-repositories.com/f/awesome-lists/devtools/file-and-directory-management/file-and-directory-moves/automatic-reference-updaters.md) — Refreshes markdown links automatically when a target file or directory is moved or renamed. ([source](https://code.visualstudio.com/docs/languages/markdown))
- [Table Aligners](https://awesome-repositories.com/f/awesome-lists/devtools/linting-and-formatting/markdown-formatting/markdown-table-generators/table-aligners.md) — Uses regular expressions to calculate column widths and align cells for GitHub Flavored Markdown tables.

### Business & Productivity Software

- [AST-Based Resolvers](https://awesome-repositories.com/f/business-productivity-software/bidirectional-link-resolution/ast-based-resolvers.md) — Implements AST-based analysis to map internal header references and file paths across the entire workspace.

### Content Management & Publishing

- [Markdown-Based Knowledge Bases](https://awesome-repositories.com/f/content-management-publishing/content-management-systems/content-architecture-modeling/markdown-ecosystem-tools/markdown-based-knowledge-bases.md) — Facilitates the management of interlinked Markdown files and maintains reference integrity during file moves.
- [Markdown Renderers](https://awesome-repositories.com/f/content-management-publishing/markdown-renderers.md) — Renders Markdown text into HTML with integrated support for KaTeX math, Mermaid diagrams, and custom CSS.
- [Reference Synchronization](https://awesome-repositories.com/f/content-management-publishing/section-header-linking/header-indexing/reference-synchronization.md) — Provides automatic synchronization of internal links throughout the workspace when headers or files are renamed. ([source](https://code.visualstudio.com/docs/languages/markdown))
- [Markdown-Based Content Authoring](https://awesome-repositories.com/f/content-management-publishing/content-management-systems/content-authoring-tools/markdown-based-content-authoring.md) — Provides a suite of authoring tools for generating tables of contents, formatting GFM tables, and inserting snippets.
- [Table of Contents](https://awesome-repositories.com/f/content-management-publishing/documentation-knowledge-management/table-of-contents.md) — Creates a linked list of headings that updates automatically on save with custom indentation support. ([source](https://cdn.jsdelivr.net/gh/yzhang-gh/vscode-markdown@master/README.md))
- [Technical Documentation](https://awesome-repositories.com/f/content-management-publishing/documentation-knowledge-management/technical-documentation.md) — Supports professional technical workflows featuring KaTeX math, Mermaid diagrams, and GFM tables.
- [Diagram Renderers](https://awesome-repositories.com/f/content-management-publishing/markdown-renderers/diagram-renderers.md) — Renders Mermaid diagrams and KaTeX math formulas as visual elements within the document preview. ([source](https://code.visualstudio.com/docs/languages/markdown))
- [Markdown to HTML Converters](https://awesome-repositories.com/f/content-management-publishing/markdown-to-html-converters.md) — Converts documents into HTML files while preserving plugin styling and resolving internal markdown links. ([source](https://cdn.jsdelivr.net/gh/yzhang-gh/vscode-markdown@master/README.md))
- [Workspace Reference Searchers](https://awesome-repositories.com/f/content-management-publishing/section-header-linking/header-indexing/workspace-reference-searchers.md) — Locates every occurrence in the workspace where a specific header or link is referenced to track dependencies. ([source](https://code.visualstudio.com/docs/languages/markdown))

### Data & Databases

- [Link Validation & Maintenance](https://awesome-repositories.com/f/data-databases/knowledge-graph-indexers/knowledge-graph-builders/bi-directional-note-linking/markdown-link-resolvers/link-validation-maintenance.md) — Ships a system for validating local links and automatically updating references when files are moved.

### Testing & Quality Assurance

- [Broken Link Scanners](https://awesome-repositories.com/f/testing-quality-assurance/broken-link-scanners.md) — Monitors file system changes to identify and flag broken local links in real time.
- [Link Validators](https://awesome-repositories.com/f/testing-quality-assurance/link-validators.md) — Checks for broken links to local files or headers to ensure all assets point to the correct destination. ([source](https://code.visualstudio.com/docs/languages/markdown))

### User Interface & Experience

- [Automated Image Alt-Text](https://awesome-repositories.com/f/user-interface-experience/custom-header-components/section-headers/section-content-descriptions/automated-image-alt-text.md) — Uses artificial intelligence to create descriptive alternative text for embedded images to improve accessibility. ([source](https://code.visualstudio.com/docs/languages/markdown))
- [Table Formatters](https://awesome-repositories.com/f/user-interface-experience/data-visualization-tools/data-visualization/specific-chart-types/table-visualizations/markdown-table-rendering/table-formatters.md) — Rearranges and aligns table cells to create a consistent visual structure for GitHub Flavored Markdown. ([source](https://cdn.jsdelivr.net/gh/yzhang-gh/vscode-markdown@master/README.md))
- [Live Preview Renderers](https://awesome-repositories.com/f/user-interface-experience/live-preview-renderers.md) — Provides a real-time visual preview of Markdown content with support for custom CSS styling.