luis-sousa-pinto / vscode-github-md-like-notion

write github readme like notion

@vscode-github-md-like-notion

a enhancer for github readme

• @vscode-github-md-like-notion
  • install
  • config
  • snippets
    • collapse - !collapse
    • description - !description
    • description - !description-with-center-logo
    • deploy-vercel - !deploy-vercel
    • inline-images - !images-inline-{count}
    • image-with-caption - !image-with-caption
    • image-with-center-caption - !image-with-center-caption
    • table-react-component-props - !table-react-props
    • inside-link - !link
    • outside-link - !link-outside
    • 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
    • single tab - !tab-item
    • date - !date
    • date with showtime - !time
    • create time - !createAt
    • emoji - !emoji-{gitmojiname}
    • keyboard - !keyboard
    • note - !note
    • warning - !warning
    • danger - !danger
    • backtotop - !backtotop
    • signature - !signature

install

ext install vscode-github-md-like-notion

config

in settings.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

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

outside-link - !link-outside

outside-link 🔗

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

• 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.

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.

danger - !danger

🚫 DANGER
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

signature - !signature

built with ❤️ by jiangweixian