Skip to content

mjbvz/vscode-github-markdown-preview-style

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
January 7, 2022 13:56
January 17, 2022 09:54
August 10, 2017 10:59
November 2, 2018 13:58
March 23, 2017 20:19
February 4, 2022 02:17
March 23, 2017 20:19
January 7, 2022 13:57
January 18, 2022 14:38
January 18, 2022 14:38

Changes VS Code's built-in markdown preview to match GitHub's styling.

Includes support for both light and dark GitHub themes. By default, the theme type (light vs dark) is selected based on your VS Code theme.

❗️ Important: This extension only styles the Markdown preview. Use this extension pack to add support for other GitHub markdown features like :emoji: and - [ ] tasklists.

Features

  • Preview what your markdown will look like rendered on GitHub.
  • Extends VS Code's built-in markdown preview.
  • Includes both light or dark Github themes.
  • Customize styling using your own markdown.styles css

Usage

Please see the VSCode Markdown Preview documentation for instructions on how to use this extension.

Configuration

This theme is configurable in a similar manner to GitHub's appearance settings.

  • markdown-preview-github-styles.colorTheme Sets the GitHub color theme for the Markdown preview. Default: auto.
    • auto: Automatically match the editor color theme.
    • system: Sync to the system/OS color theme.
    • light: Always use the GitHub site's light theme.
    • dark: Always use the GitHub site's dark theme.

About

VS Code extension that changes the built-in markdown preview to match Github's styling

Resources

License

Stars

Watchers

Forks

Packages

No packages published