https://github.com/jiangweixian/vscode-github-md-like-notion
write github readme like notion
https://github.com/jiangweixian/vscode-github-md-like-notion
github notion snippets vscode
Last synced: about 2 months ago
JSON representation
write github readme like notion
- Host: GitHub
- URL: https://github.com/jiangweixian/vscode-github-md-like-notion
- Owner: JiangWeixian
- License: mit
- Created: 2020-06-05T12:09:34.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-03-06T13:55:24.000Z (over 1 year ago)
- Last Synced: 2024-05-01T17:38:04.218Z (about 1 year ago)
- Topics: github, notion, snippets, vscode
- Language: JavaScript
- Homepage:
- Size: 107 KB
- Stars: 16
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# @vscode-github-md-like-notion
*a enhancer for github readme*
[](https://marketplace.visualstudio.com/items?itemName=jiangweixian.vscode-github-md-like-notion) [](https://marketplace.visualstudio.com/items?itemName=jiangweixian.vscode-github-md-like-notion)
- [@vscode-github-md-like-notion](#vscode-github-md-like-notion)
- [install](#install)
- [config](#config)
- [snippets](#snippets)
- [collapse - `!collapse`](#collapse---collapse)
- [description - `!description`](#description---description)
- [description - `!description-with-center-logo`](#description---description-with-center-logo)
- [deploy-vercel - `!deploy-vercel`](#deploy-vercel---deploy-vercel)
- [inline-images - `!images-inline-{count}`](#inline-images---images-inline-count)
- [image-with-caption - `!image-with-caption`](#image-with-caption---image-with-caption)
- [image-with-center-caption - `!image-with-center-caption`](#image-with-center-caption---image-with-center-caption)
- [table-react-component-props - `!table-react-props`](#table-react-component-props---table-react-props)
- [inside-link - `!link`](#inside-link---link)
- [outside-link - `!link-outside`](#outside-link---link-outside)
- [backers - `!backers`](#backers---backers)
- [contributors - `!contributors`](#contributors---contributors)
- [badge-producthunt - `!badge-producthunt`](#badge-producthunt---badge-producthunt)
- [badge-applestore - `!badge-applestore`](#badge-applestore---badge-applestore)
- [badge-googleplay - `!badge-googleplay`](#badge-googleplay---badge-googleplay)
- [badge-googleplay - `!badge-crx`](#badge-googleplay---badge-crx)
- [button-sponsor-pateron - `!sponsor-pateron`](#button-sponsor-pateron---sponsor-pateron)
- [tabs - `!tabs`](#tabs---tabs)
- [single tab - `!tab-item`](#single-tab---tab-item)
- [date - `!date`](#date---date)
- [date with showtime - `!time`](#date-with-showtime---time)
- [create time - `!createAt`](#create-time---createat)
- [emoji - `!emoji-{gitmojiname}`](#emoji---emoji-gitmojiname)
- [keyboard - `!keyboard`](#keyboard---keyboard)
- [note - `!note`](#note---note)
- [tip - `!tip`](#tip---tip)
- [important - `!important`](#important---important)
- [warning - `!warning`](#warning---warning)
- [caution - `!caution` | `!danger`](#caution---caution--danger)
- [backtotop - `!backtotop`](#backtotop---backtotop)
- [signature - `!signature`](#signature---signature)
- [](#)
## install
```bash
ext install vscode-github-md-like-notion
```
## config
**in settings.json**
```json
"[markdown]": {
// ...
"editor.quickSuggestions": {
"other": true,
"comments": false,
"strings": false
},
// ...
},
```
## snippets
### collapse - `!collapse`
summary
description
### description - `!description`
### description - `!description-with-center-logo`
*a enhancer for github readme*
### deploy-vercel - `!deploy-vercel`
[](https://github.com/jiangweixian/vscode-github-md-like-notion/tree/master)
### inline-images - `!images-inline-{count}`
> four-inline-image example
### image-with-caption - `!image-with-caption`
*▲ avatar*
### image-with-center-caption - `!image-with-center-caption`
*▲ avatar*
### table-react-component-props - `!table-react-props`
|name|description|type|default|
|:---:|:---:|:---:|:---|
|props-a|a|string|just a test|
### inside-link - `!link`
[inside-link](https://github.com/JiangWeixian/vscode-github-md-like-notion)
### outside-link - `!link-outside`
[outside-link 🔗](https://github.com/JiangWeixian/vscode-github-md-like-notion)
### backers - `!backers`
### contributors - `!contributors`
### badge-producthunt - `!badge-producthunt`
### badge-applestore - `!badge-applestore`
### badge-googleplay - `!badge-googleplay`
### badge-googleplay - `!badge-crx`
### button-sponsor-pateron - `!sponsor-pateron`
### tabs - `!tabs`
[tab1]()・[tab2]()
### single tab - `!tab-item`
・[tab2]()
### date - `!date`
2020/06/06
### date with showtime - `!time`
`
2020/06/06 15:15:58
### create time - `!createAt`
`
created at 2020/06/06 15:15:58
### emoji - `!emoji-{gitmojiname}`
> some useful emoji from [gitmoji](https://gitmoji.carloscuesta.me/)
- features - ✨
- bug - 🐛
- tada - 🎉
- wip - 🚧
- config - 🔧
- docs - 📝
- perf - ⚡️
- refactor - ♻️
- deploy - 🚀
### keyboard - `!keyboard`
ctrl
### note - `!note`
> [!NOTE]
> Etiam pretium lectus non ipsum dignissim, sit amet tempus ligula iaculis. Fusce nec lacus in eros pretium porttitor id ac purus. Ut rhoncus ligula at condimentum pulvinar. Nam condimentum nisi eget bibendum varius. Etiam volutpat eros non suscipit vulputate.
>
### tip - `!tip`
> [!TIP]
> Etiam pretium lectus non ipsum dignissim, sit amet tempus ligula iaculis. Fusce nec lacus in eros pretium porttitor id ac purus. Ut rhoncus ligula at condimentum pulvinar. Nam condimentum nisi eget bibendum varius. Etiam volutpat eros non suscipit vulputate.
### important - `!important`
> [!important]
> Etiam pretium lectus non ipsum dignissim, sit amet tempus ligula iaculis. Fusce nec lacus in eros pretium porttitor id ac purus. Ut rhoncus ligula at condimentum pulvinar. Nam condimentum nisi eget bibendum varius. Etiam volutpat eros non suscipit vulputate.
### warning - `!warning`
> [!WARNING]
> Etiam pretium lectus non ipsum dignissim, sit amet tempus ligula iaculis. Fusce nec lacus in eros pretium porttitor id ac purus. Ut rhoncus ligula at condimentum pulvinar. Nam condimentum nisi eget bibendum varius. Etiam volutpat eros non suscipit vulputate.
### caution - `!caution` | `!danger`
> [!CAUTION]
> Etiam pretium lectus non ipsum dignissim, sit amet tempus ligula iaculis. Fusce nec lacus in eros pretium porttitor id ac purus. Ut rhoncus ligula at condimentum pulvinar. Nam condimentum nisi eget bibendum varius. Etiam volutpat eros non suscipit vulputate.
### backtotop - `!backtotop`
[⭡backtotop](#readme)
### signature - `!signature`
#
*built with ❤️ by jiangweixian*