Skip to content

Commit 5ae8273

Browse files
committed
Udpate 1.0.0 version info
1 parent 886ad13 commit 5ae8273

File tree

1 file changed

+33
-51
lines changed

1 file changed

+33
-51
lines changed

README.md

Lines changed: 33 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,47 @@
1-
# vscode-hackmd README
2-
3-
This is the README for your extension "vscode-hackmd". After writing up a brief description, we recommend including the following sections.
1+
# HackMD official VSCode extension
42

53
## Features
64

7-
Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
8-
9-
For example if there is an image subfolder under your extension project workspace:
10-
11-
\!\[feature X\]\(images/feature-x.png\)
12-
13-
> Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow.
14-
15-
## Requirements
5+
- HackMD-compatible markdown rendering preview
6+
- We bring most HackMD supported syntax into VSCode :tada:
167

17-
If you have any requirements or dependencies, add a section describing those and how to install and configure them.
8+
#### Render codeblock with line numbers
189

19-
## Extension Settings
10+
![](https://i.imgur.com/X31HZqm.png)
2011

21-
Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.
12+
#### MathJax, Diagrams
2213

23-
For example:
24-
25-
This extension contributes the following settings:
26-
27-
* `myExtension.enable`: enable/disable this extension
28-
* `myExtension.thing`: set to `blah` to do something
29-
30-
## Known Issues
31-
32-
Calling out known issues can help limit users opening duplicate issues against your extension.
14+
![](https://i.imgur.com/6vpxBbo.png)
15+
![](https://i.imgur.com/pinXrf6.png)
16+
![](https://i.imgur.com/M15g6It.png)
3317

3418
## Release Notes
3519

36-
Users appreciate release notes as you update your extension.
37-
3820
### 1.0.0
3921

40-
Initial release of ...
41-
42-
### 1.0.1
43-
44-
Fixed issue #.
45-
46-
### 1.1.0
47-
48-
Added features X, Y, and Z.
49-
50-
-----------------------------------------------------------------------------------------------------------
51-
52-
## Working with Markdown
53-
54-
**Note:** You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
55-
56-
* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux)
57-
* Toggle preview (`Shift+CMD+V` on macOS or `Shift+Ctrl+V` on Windows and Linux)
58-
* Press `Ctrl+Space` (Windows, Linux) or `Cmd+Space` (macOS) to see a list of Markdown snippets
59-
60-
### For more information
22+
Initial Release!
23+
24+
#### Added
25+
26+
- markdown-it plugins
27+
- markdown-it-abbr
28+
- markdown-it-container
29+
- markdown-it-deflist
30+
- markdown-it-ins
31+
- markdown-it-mark
32+
- markdown-it-mathjax
33+
- markdown-it-sub
34+
- markdown-it-sup
35+
- checkbox (As extension dependency)
36+
- markdown-it-emoji
37+
- markdown-it-footnote
38+
- markdown-it-imsize
39+
- External Graph Renderer
40+
- Mermaid
41+
- Sequence Diagram
42+
- Flowchart
43+
- Graphviz
44+
- abc.js
45+
- Mathjax
6146

62-
* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
63-
* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)
6447

65-
**Enjoy!**

0 commit comments

Comments
 (0)