We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
本地运行:
npm run docs:build
这样可以检查编译是否正确,排除一些链接错误的问题
不带目录的文件名例如:
Token Program 官网地址为 https://spl.solana.com/token 带有文件名token, 本地文件名为token.md
token
token.md
带有目录的文件名例如:
Proposed Inflation Schedule 官网地址为 https://solana.com/zh/docs/economics/inflation/inflation-schedule 带有目录economics/inflation和文件名inflation-schedule,本地文件名为economics/inflation/inflation-schedule.md
economics/inflation
inflation-schedule
economics/inflation/inflation-schedule.md
不带有目录和文件名例如:
staking 官网地址为 https://solana.com/docs/economics/staking/ 只有目录没有文件名,本地文件名需要命名为和目录同名staking.md,不能命名为index,因为index文件会出现下一页显示不正常现象
staking.md
index
有些官网的井号级别并不是按照从小到大的顺序进行的,例如Backward Compatibility Policy在这个页面的源代码中可以看到井号是从###开始的,我们如果这样做,会导致页面在渲染后显示右边栏导航错误,所以我们要修改井号的级别
对应蓝色(INFO)、黄色(CAUTION)、红色(WARNING)的引用框使用下面的方法翻译,在文档渲染后可以保持原样
::: tip INFO This is a INFO. :::
::: warning CAUTION This is a CAUTION. :::
::: danger WARNING This is a WARNING. :::
The text was updated successfully, but these errors were encountered:
你好, 我如在阅读文档的过程中发现的话,可以直接提PR吗?这个有对应的流程吗?
Sorry, something went wrong.
No branches or pull requests
在提交pr之前需要本地运行build检查
本地运行:
这样可以检查编译是否正确,排除一些链接错误的问题
保留官网链接地址
文档名称和官网文档名称一致
不带目录的文件名例如:
Token Program 官网地址为 https://spl.solana.com/token 带有文件名
token
, 本地文件名为token.md
带有目录的文件名例如:
Proposed Inflation Schedule 官网地址为 https://solana.com/zh/docs/economics/inflation/inflation-schedule 带有目录
economics/inflation
和文件名inflation-schedule
,本地文件名为economics/inflation/inflation-schedule.md
不带有目录和文件名例如:
staking 官网地址为 https://solana.com/docs/economics/staking/ 只有目录没有文件名,本地文件名需要命名为和目录同名
staking.md
,不能命名为index
,因为index文件会出现下一页显示不正常现象井号#️⃣级别问题
专有名词翻译规范
引用翻译方法
对应蓝色(INFO)、黄色(CAUTION)、红色(WARNING)的引用框使用下面的方法翻译,在文档渲染后可以保持原样
::: tip INFO
This is a INFO.
:::
::: warning CAUTION
This is a CAUTION.
:::
::: danger WARNING
This is a WARNING.
:::
图片问题
The text was updated successfully, but these errors were encountered: