这是一份快速开始文档,可以把这个页面看作是一个导航页面,掌握这个导航内所介绍的知识,可以快速掌握Raven引擎。
Raven 目前使用rust编译 工具链进行数据编译 如果你还没有安装 Rust, 你可以使用官方提供的 rustup 安装 Rust.
当前 支持的 Rust 版本为 1.85. 运行 rustup update确认您已经安装了符合要求的 Rust.
When you want to use React components in Markdown files, you should name your files with .mdx
extension. For example:
You can add Front Matter at the beginning of your Markdown file, which is a YAML-formatted object that defines some metadata. For example:
Note: By default, Rspress uses h1 headings as html headings.
You can also access properties defined in Front Matter in the body, for example:
The previously defined properties will be passed to the component as frontmatter
properties. So the final output will be:
You can use the :::
syntax to create custom containers and support custom titles. For example:
Input:
Output:
This is a block
of type tip
This is a block
of type info
This is a block
of type warning
This is a block
of type danger
This is a block
of type details
This is a block
of Custom Title
This is a block
of Custom Title
You can use the ``` syntax to create code blocks and support custom titles. For example:
Input:
Output:
If you want to display line numbers, you can enable the showLineNumbers
option in the config file:
If you want to wrap long code line by default, you can enable the defaultWrapCode
option in the config file:
You can also apply line highlighting and code block title at the same time, for example:
Input:
Output:
You can enable Rustify MDX compiler by following config: