-
-
Notifications
You must be signed in to change notification settings - Fork 173
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Now vscode version matches the atom version.
- Loading branch information
Showing
11 changed files
with
86 additions
and
1,667 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,107 +1,41 @@ | ||
| # Markdown Preview Enhanced | ||
| <h1 align="center"> Markdown Preview Enhanced </h1> | ||
|
|
||
|
|
||
| This extension is powered by [Mume](https://github.com/shd101wyy/mume). | ||
|  | ||
|
|
||
| Trying hard to port [Markdown Preview Enhanced for Atom](https://github.com/shd101wyy/markdown-preview-enhanced) to vscode. | ||
| <p align="center"> | ||
| <a href="https://shd101wyy.github.io/markdown-preview-enhanced/#/"> English </a> | ||
| <a href="https://shd101wyy.github.io/markdown-preview-enhanced/#/zh-cn/"> 简体中文 </a> | ||
| <a href="https://shd101wyy.github.io/markdown-preview-enhanced/#/zh-tw/"> 正體中文 </a> <br> | ||
| </p> | ||
|
|
||
| Below is a demo of the Atom version. | ||
| [Website for Atom (outdated)](https://shd101wyy.github.io/markdown-preview-enhanced/#/). | ||
|  | ||
| <p align="center"> | ||
| <a href="https://atom.io/packages/markdown-preview-enhanced">atom</a> | ||
| & | ||
| <a href="https://marketplace.visualstudio.com/items?itemName=shd101wyy.markdown-preview-enhanced">vscode</a> | ||
| </p> | ||
|
|
||
| ## Features | ||
| * <kbd>ctrl-shift-m</kbd> for `Markdown Preview Enhanced: Open Preview` command. | ||
| * <kbd>ctrl-shift-i</kbd> for `Markdown Preview Enhanced: Image Helper` command. | ||
| * Support uploading images to either `imgur` or `sm.ms`. | ||
|  | ||
| * <kbd>shift-enter</kbd> for `Markdown Preview Enhanced: Run Code Chunk` command. | ||
| * <kbd>ctrl-shift-enter</kbd> for `Markdown Preview Enhanced: Run All Code Chunks` command. | ||
| * `Markdown Preview Enhanced: Customize CSS` | ||
| * `Markdown Preview Enhanced: Create TOC` | ||
| * `Markdown Preview Enhanced: Open Mermaid Config` | ||
| * `Markdown Preview Enhanced: Open MathJax Config` | ||
| * `Markdown Preview Enhanced: Open PhantomJS Config` | ||
| * `Markdown Preview Enhanced: Open Welcome Page` | ||
| * `Markdown Preview Enhanced: Extend Parser` | ||
| * `Markdown Preview Enhanced: Insert New Slide` | ||
| * `Markdown Preview Enhanced: Insert Table` | ||
| * `Markdown Preview Enhanced: Insert Page Break` | ||
| * `Markdown Preview Enhanced: Show Uploaded Images` | ||
| *Still Beta Version!* | ||
|
|
||
| * **Right Click** at the Preview to see the contextmenu | ||
| ## Supporting this project | ||
| Markdown Preview Enhanced is an open source project released under the [University of Illinois/NCSA Open Source License](LICENSE.md). Its ongoing development is made possible thanks to the support by these awesome [backers](https://shd101wyy.github.io/markdown-preview-enhanced/#/backers). You can help make this project better by [supporting us on Patreon](https://www.patreon.com/shd101wyy) or [微信支付 Wechat Pay](https://shd101wyy.github.io/markdown-preview-enhanced/#/wechat). Thank you! | ||
|
|
||
|  | ||
| ## Introduction | ||
| Markdown Preview Enhanced is an extension that provides you with many useful functionalities such as automatic scroll sync, math typesetting, mermaid, PlantUML, pandoc, PDF export, code chunk, etc. A lot of its ideas are inspired by [Markdown Preview Plus](https://github.com/atom-community/markdown-preview-plus) and [RStudio Markdown](http://rmarkdown.rstudio.com/). | ||
|
|
||
| For more features that will be supported in the future, check [Markdown Preview Enhanced for atom](https://shd101wyy.github.io/markdown-preview-enhanced/#/). | ||
| Feel free to ask questions, post issues, submit pull request, and request new features. | ||
|
|
||
| ## Extension Settings | ||
| For more information about this project and how to use this extension, please check out our documentation ⬇︎ | ||
|
|
||
| Search `markdown-preview-enhanced` in settings. | ||
| ## Documentation | ||
| To check out the documentation, visit | ||
| * [English](https://shd101wyy.github.io/markdown-preview-enhanced/#/) | ||
| * [简体中文](https://shd101wyy.github.io/markdown-preview-enhanced/#/zh-cn/) | ||
| * [正體中文](https://shd101wyy.github.io/markdown-preview-enhanced/#/zh-tw/) | ||
|
|
||
| For example, `"markdown-preview-enhanced.previewTheme": "gothic.css"` renders Gothic preview theme: | ||
|  | ||
| Contact me if you are willing to help translate the documentation :) | ||
|
|
||
| ## Porting Progress | ||
| ### July 12, 2017 | ||
| * New design for prensentation mode. Multiple revealjs presentation themes are provided. | ||
| * Added `Welcome Page`. | ||
| * Update `Mume` to version `0.1.0`. | ||
| ## Changelog | ||
| Please check the [Releases](https://github.com/shd101wyy/vscode-markdown-preview-enhanced/releases) page of this project. | ||
|
|
||
| ### July 11, 2017 | ||
| * Migrate **core library** out from this extension to [Mume](https://github.com/shd101wyy/mume). In the future the mpe both vscode and atom will share the same core. | ||
| * Support Task List (TODO) for pandoc parser. Added click event for checkbox. | ||
| * Add preview themes: `Medium`, `None`. | ||
| * Add `Markdown Preview Enhanced: Extend Parser` command. | ||
| * Fix issue [#17](https://github.com/shd101wyy/vscode-markdown-preview-enhanced/issues/17#issuecomment-314016606). | ||
|
|
||
| ### July 4, 2017 | ||
| * Done [PhantomJS export](./docs/phantomjs.md). | ||
| * Done [pandoc parser](https://shd101wyy.github.io/markdown-preview-enhanced/#/pandoc?id=pandoc-parser) support. | ||
| * Added `Gothic`, `Newsprint`, and `Night` preview themes. | ||
|
|
||
| ### June 20, 2017 | ||
| * Done [Pandoc export](https://shd101wyy.github.io/markdown-preview-enhanced/#/pandoc-pdf). (Not tested). | ||
| * Done Markdown(GFM) export. (Not tested) | ||
| * Done [TOC](https://shd101wyy.github.io/markdown-preview-enhanced/#/toc) implementation. | ||
| > The vscode version is newer than the atom version. | ||
| > To ignore a heading from TOC, you need to set `{ignore: true}`. | ||
| > To add class and id, you need to set `{id:"...", class:"..."}`. | ||
| * Done Code Chunk implementation. Added two more options `modify_source` and `run_on_save`. Please check [this doc](./docs/code-chunk.md) for more information. | ||
| * Done [Customize CSS](https://shd101wyy.github.io/markdown-preview-enhanced/#/customize-css) support. | ||
| * Done `mermaid` configuration supoort. | ||
| * Done `MathJax` configuration support. | ||
| * Done `line-numbers`. Simply add `line-numbers` to code block(chunk) `class`. | ||
|
|
||
|  | ||
|
|
||
| ### June 16, 2017 | ||
| * Done supporting [eBook export](https://shd101wyy.github.io/markdown-preview-enhanced/#/ebook). | ||
| * [@import](https://shd101wyy.github.io/markdown-preview-enhanced/#/file-imports) 70% done. Now support importing every external files except `.js` and `.pdf` files. | ||
| * Done implementing refresh button in preview. | ||
| * [Code Chunk](https://shd101wyy.github.io/markdown-preview-enhanced/#/code-chunk) implementation is now 60% done. LaTeX and JavaScript don't work yet. | ||
| Please note that Code Chunk of [Markdown Preview Enhanced for Atom](https://shd101wyy.github.io/markdown-preview-enhanced/#/code-chunk) is outdated. The syntax of the vscode version is the newest. You need to have `cmd` set to declare a code chunk. | ||
|
|
||
|
|
||
|  | ||
|
|
||
| ### June 14, 2017 | ||
| * Scroll sync is partially done. | ||
| * Done supporting `mermaid`, `PlantUML` and `viz.js` (GraphViz). | ||
| * Done supporting `[TOC]`. | ||
| * Done supporting `MathJax` and `KaTeX`. | ||
| * Done sidebar TOC. | ||
| * Done back to top button. | ||
| * Done supporting front matter. | ||
| * Done supporting `reveal.js` presentation mode. Try inserting `<!-- slide -->` to your markdown. | ||
| * Done `Open in Browser`. | ||
| * Done HTML export. | ||
| * Done `prince` PDF export. | ||
| * Done `Image Helper`. | ||
| * Done supporting single preview. | ||
|
|
||
| ## My Questions | ||
| It would be great if you can answer my following questions to help develop this extension. | ||
| 1. Is there a `onDidChangeScrollTop` function for `TextEditor` in vscode. So that I can track the change of scrollTop position of the text editor. | ||
| 1. Can I manually set the `scrollTop` of `TextEditor`? | ||
| 1. How to programmatically close my preview by `uri`? I tried to implement the `Toggle Preview` command but failed because I don't know how to close a preview. So now only `Open Preview` is provided. | ||
| 1. How do I programmatically close the a `Preview` by `vscode.Uri`? | ||
| ## License | ||
| [University of Illinois/NCSA Open Source License](LICENSE.md) |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| ## Anouncement | ||
| I think I have finished porting [Markdown Preview Enhanced for Atom](https://atom.io/packages/markdown-preview-enhanced) successfully to VS Code. Cheers :) | ||
|
|
||
|
|
||
| ## 0.1.8 | ||
|
|
||
| * Upgraded [mume](https://github.com/shd101wyy/mume) to version `0.1.2`. | ||
| * Switched the default markdown parser from `remarkable` to `markdown-it`. | ||
| * Fixed pandoc export front-matter not included bug. | ||
| * Fixed `bash` language highlighting bug. | ||
| * Fixed phantomjs export task list bug. | ||
| * Upgraded `webview.ts` script for preview. Now both Atom and VS Code versions share the same preview logic. | ||
| * Removed several redundandent dependencies. | ||
| * Added several new code block themes. |
Oops, something went wrong.