https://github.com/atom/markdown-preview

📝 Markdown preview in Atom
https://github.com/atom/markdown-preview

Last synced: 5 months ago
JSON representation

📝 Markdown preview in Atom

• Host: GitHub
• URL: https://github.com/atom/markdown-preview
• Owner: atom
• License: mit
• Archived: true
• Created: 2013-08-13T17:08:57.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2022-09-28T10:52:03.000Z (over 2 years ago)
• Last Synced: 2024-09-27T02:47:39.237Z (8 months ago)
• Language: JavaScript
• Homepage:
• Size: 702 KB
• Stars: 1,229
• Watchers: 42
• Forks: 358
• Open Issues: 150
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
##### Atom and all repositories under Atom will be archived on December 15, 2022. Learn more in our [official announcement](https://github.blog/2022-06-08-sunsetting-atom/)

 # Markdown Preview package

[![macOS Build Status](https://travis-ci.org/atom/markdown-preview.svg?branch=master)](https://travis-ci.org/atom/markdown-preview) [![Windows Build Status](https://ci.appveyor.com/api/projects/status/bvh0evhh4v6w9b29/branch/master?svg=true)](https://ci.appveyor.com/project/Atom/markdown-preview/branch/master) [![Dependency Status](https://david-dm.org/atom/markdown-preview.svg)](https://david-dm.org/atom/markdown-preview)

Show the rendered HTML markdown to the right of the current editor using ctrl-shift-m.

It is currently enabled for `.markdown`, `.md`, `.mdown`, `.mkd`, `.mkdown`, `.ron`, and `.txt` files.

![markdown-preview](https://cloud.githubusercontent.com/assets/378023/10013086/24cad23e-6149-11e5-90e6-663009210218.png)

## Customize

By default Markdown Preview uses the colors of the active syntax theme. Enable `Use GitHub.com style` in the __package settings__ to make it look closer to how markdown files get rendered on github.com.

![markdown-preview GitHub style](https://cloud.githubusercontent.com/assets/378023/10013087/24ccc7ec-6149-11e5-97ea-53a842a715ea.png)

To customize even further, the styling can be overridden in your `styles.less` file. For example:

```css

.markdown-preview.markdown-preview {

  background-color: #444;

}

```