Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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: 16 days ago
JSON representation

write github readme like notion

Awesome Lists containing this project

README

        

# @vscode-github-md-like-notion

*a enhancer for github readme*

[![Visual Studio Marketplace Installs](https://img.shields.io/visual-studio-marketplace/i/jiangweixian.vscode-github-md-like-notion?style=flat-square)](https://marketplace.visualstudio.com/items?itemName=jiangweixian.vscode-github-md-like-notion) [![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/jiangweixian.vscode-github-md-like-notion?style=flat-square)](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`

![logo](https://avatars2.githubusercontent.com/u/6839576?s=460&u=ae20ee0b187d0c4f70cae7daa12ae09fb47b78a9&v=4)

*a enhancer for github readme*

### deploy-vercel - `!deploy-vercel`

[![Deploy with Vercel](https://vercel.com/button)](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](https://avatars2.githubusercontent.com/u/6839576?s=460&u=ae20ee0b187d0c4f70cae7daa12ae09fb47b78a9&v=4 "avatar")
*β–² avatar*

### image-with-center-caption - `!image-with-center-caption`

![avatar](https://avatars2.githubusercontent.com/u/6839576?s=460&u=ae20ee0b187d0c4f70cae7daa12ae09fb47b78a9&v=4 "avatar")
*β–² 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`

Collaborative Markdown Editor - Collaborative editor with end-to-end encryption. | Product Hunt Embed

### badge-applestore - `!badge-applestore`

apple-appstore

### badge-googleplay - `!badge-googleplay`

googleplay-store

### badge-googleplay - `!badge-crx`

chrome-webstore

### button-sponsor-pateron - `!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*