Add Versions
当我们的示例站点部署成功了,现在我们来尝试使用 Docusaurus 的一个杀手锏功能-版本文档。 Versioned documentation helps to show relevant documentation to the users for the current version of the tool they are using and also hide unreleased documentation from users, reducing confusion. Documentations for older versions are also preserved and accessible to users of older versions of the tool even as the latest documentation changes.
{.docImage}
Releasing a Version
假设我们对文档的现状感到满意,我们希望将其打包为v1.0.0版本的文档。 首先我们运行一下命令来生成一个 versions.js
的文件,用于列出项目中所有文档的版本。
npm run examples versions # yarn examples versions
接下来,我们用我们想要创建的版本运行命令,例如1.0.0,
npm run version 1.0.0 # yarn version 1.0.0
这将保存当前在docs
目录中的所有文档,并将其作为1.0.0版本的文档提供。
docs
目录中的文件将被视为下一个版本的一部分,例如,它们可在网址localhost:3000/<baseUrl>/docs/next/doc1
上查阅。 最新版本的文档使用 URL docs/doc1
。
让我们来测试版本化实际上是有效的。 我们可以修改 docs/doc1.md
文档的第一行:
---
id: doc1
title: Latin-ish
sidebar_label: Example Page
---
- Check the [documentation](https://docusaurus.io) for how to use Docusaurus.
+ This is the latest version of the docs.
## Lorem
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies.
如果我们在我们的浏览器中打开 localhost:3000/<baseUrl>/docs/doc1
URL,我们看到它仍然显示前一行。 这是因为我们现在看到的版本是 1.0.0版本,它已经被冻结。
下一个版本
文档的最新版本必须添加next
到URL:localhost:3000/<baseUrl>/docs/next/doc1
。 请注意,当我们访问该 URL 的时候标题旁边的版本也更改为next
。
我们创建了一个版本详情页面:localhost:3000/<baseUrl>/versions
,该页面显示当前文档的所有版本。 See that both 1.0.0
and master
are being listed here and they correctly link to the respective versions of the documentation.
继续吧,发布属于你的版本文档。
总结
都在这儿了! In this short tutorial, you have experienced how easy it was to create a documentation website from scratch and making versions for them. 您可以在 Docusaurus 上做更多的事情,例如添加博客、搜索和翻译。 查看更多内容请查阅:指南 部分。