Skip to content

Commit 18fad4b

Browse files
committed
feat: add prism
1 parent 71701ef commit 18fad4b

File tree

7 files changed

+603
-56
lines changed

7 files changed

+603
-56
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2020-present Mirone
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 16 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,30 @@
1-
# milkdown README
1+
# Milkdown 💖 VSCode
22

3-
This is the README for your extension "milkdown". After writing up a brief description, we recommend including the following sections.
3+
Use [Milkdown](https://saul-mirone.github.io/milkdown/#/) in your favorite editor to edit markdown.
44

55
## Features
66

7+
> Plugin is still in dev progress, this is an early access version.
8+
79
Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
810

911
For example if there is an image subfolder under your extension project workspace:
1012

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
16-
17-
If you have any requirements or dependencies, add a section describing those and how to install and configure them.
18-
19-
## Extension Settings
20-
21-
Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.
22-
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.
33-
34-
## Release Notes
35-
36-
Users appreciate release notes as you update your extension.
37-
38-
### 1.0.0
39-
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-
## Following extension guidelines
52-
53-
Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.
54-
55-
* [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines)
13+
![Show](/milkdown-vscode.gif)
5614

57-
## Working with Markdown
15+
### Usage:
5816

59-
**Note:** You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
17+
- Right click in editor to open in milkdown.
18+
- Right click in explorer bar and select open in milkdown.
19+
- Search `Milkdown` in command palette with `Cmd/Ctrl + Shift + P`.
6020

61-
* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux)
62-
* Toggle preview (`Shift+CMD+V` on macOS or `Shift+Ctrl+V` on Windows and Linux)
63-
* Press `Ctrl+Space` (Windows, Linux) or `Cmd+Space` (macOS) to see a list of Markdown snippets
21+
### Feature List
6422

65-
### For more information
23+
- WYSIWYG Markdown Editor
24+
- Full GFM syntax support
25+
- Emoji picker and filter
26+
- Copy and paste with markdown
6627

67-
* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
68-
* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)
28+
## License
6929

70-
**Enjoy!**
30+
[MIT](/LICENSE)

milkdown-vscode.gif

246 KB
Loading

package.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,8 @@
7979
"@milkdown/plugin-emoji": "^4.10.2",
8080
"@milkdown/plugin-history": "^4.10.2",
8181
"@milkdown/plugin-listener": "^4.10.2",
82+
"@milkdown/plugin-math": "^4.10.2",
83+
"@milkdown/plugin-prism": "^4.10.2",
8284
"@milkdown/plugin-slash": "^4.10.2",
8385
"@milkdown/plugin-tooltip": "^4.10.2",
8486
"@milkdown/preset-gfm": "^4.10.2",

pnpm-lock.yaml

Lines changed: 146 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)