Skip to content

Markdown

TIP

This documentation is still being written. Please check back later.

Markdown is a lightweight markup language with plain text formatting syntax. It is designed so that it can be converted to HTML and many other formats using a tool by the same name. Markdown is often used to format readme files, for writing messages in online discussion forums, and to create rich text using a plain text editor.

Markdown or MDX

Markdown has top-level support in Velite. Although we also support MDX, I think that MDX is not the best choice for content creators. Although it is powerful and has stronger programmability, it is easy to lose the essence of writing and recording, and become addicted to technology.

  • Portable: Markdown is portable, you can use it anywhere, even in the terminal.
  • Simple: Markdown is simple, you can learn it in 10 minutes, don't need to spend a lot of time to learn React.
  • Easy to use: Markdown is easy to use, you can use it to write documents, write blogs, and even write books.
  • Stronger by extension: Markdown is extensible, you can use it to write code, write math formulas, and even write music.

Distributed under the MIT License.