search

wevm / vocs

Minimal Documentation Framework, powered by React + Vite.
https://vocs.dev
Other
1.04k stars 40 forks source link

Document Admonitions usage and Steps #84

Closed sambacha closed 5 months ago

sambacha commented 5 months ago

When considering to use vocs, portability and conversion of existing documentation formatting is a key consideration. 

Knowing that I dont have to edit framework specific stuff is good to know

Docusarus style admonitions are used 

https://github.com/wevm/vocs/blob/312a1786ab5a17c5b97cb6f52ab96ad57309602b/site/pages/docs/guides/markdown-snippets.mdx#L5

also this Steps keyword produces this

jxom commented 5 months ago

All of it is documented here: https://vocs.dev/docs/markdown, if that's what you mean.