2020年1月9日,星期四
新的 Next.js 文档
作者我们很高兴地宣布新的 Next.js 文档,其特色包括
- 改进的内容:添加了新的部分来解释核心概念和功能。
- 搜索:使用新的侧边栏在文档中进行模糊搜索。
- API 参考 这是最常被要求添加的文档之一。Next.js 文档现在有一个单独的 API 参考部分。
- Next.js GitHub 仓库的一部分:文档内容仍然位于 Next.js 仓库中。确保文档更新与新功能同步。
除了新的和改进的文档之外,我们还对 nextjs.org/learn 做了一些更改,使使用 Next.js 入门变得更加容易
- 不再需要登录:我们去掉了 GitHub 登录,因此您可以立即开始学习。您仍然可以获得积分!
- 新的 API 路由课程:一个新的课程解释了使用 Next.js 创建 API 端点以及如何使用 SWR 获取它的基础知识。
改进的内容
以前,Next.js 文档存在于单个 readme.md
文档中。在过去的三年里,文档不断改进,规模不断扩大,涵盖了框架的所有方面。
随着时间的推移,文档页面变得相当长,我们开始收到社区的反馈,他们认为最好将文档拆分成更小的部分,以便能够独立地阅读和搜索。
与我们所有版本一样,我们与社区成员密切合作,以找到最佳的页面结构。
我们决定采用多页面结构,其中每个部分解释一个单独的概念。允许用户更快地找到相关内容。
侧边栏也进行了更新,以更好地对内容进行排序,重点关注核心功能和概念,而不是显示所有内容并将高级功能与基本功能结合在一起。
除了改进结构外,还在文档中添加了一些新部分。最值得注意的是
- nextjs.org/docs/pages/building-your-application/routing/pages-and-layouts:Next.js 中的
pages
是什么,以及它们如何与静态生成和服务器端渲染相关。 - nextjs.org/docs/pages/building-your-application/routing:文件系统支持的不同类型的路由。
搜索
迁移到多页面文档后,您会失去单页面文档的一个重要优势,即无法使用cmd + f
(或 Windows/Linux 上的ctrl + f
)进行搜索。
我们在文档侧边栏中添加了一个新的搜索输入框,允许您在所有文档页面中进行模糊搜索。
此新增功能使文档仍然感觉像一个单页面。
API 参考
侧边栏现在有一个专门的 API 参考部分。此文档新增内容经常被使用 Next.js 的公司和社区成员请求,他们只想查找要传递的参数或要调用的函数。
以前,这些参考与功能说明交织在一起。
Next.js GitHub 仓库的一部分
从项目开始,Next.js 文档的唯一位置就是位于 GitHub 仓库中的 readme.md
。
当nextjs.org 网站发布时,我们会通过定期将内容从 Next.js GitHub 仓库复制到网站 GitHub 仓库来手动保持文档更改的最新状态。我们必须这样做是因为网站上的页面由MDX提供支持。
手动复制并不是理想的方法,我们开始研究更好的解决方案。我们希望新的文档贡献方式与当前方式一样低摩擦,在 Next.js GitHub 仓库中更新 Markdown 文件,而无需了解网站的工作原理。
通过使用 Next.js 对每个页面进行静态生成的新支持(提案),我们能够将文档保留在 Next.js 仓库中。
来自原始 GitHub 文件 URL 的 Markdown 在 getStaticProps
中获取并渲染为 HTML。由于不再需要 MDX,因此发送到浏览器的 JavaScript 减少了。
我们还希望简化对单个文档页面的贡献。为此,我们在每个文档页面的底部添加了一个“在 GitHub 上编辑此页面”链接。
当对文档进行更新时,它将自动随每个新的稳定版本一起发布。使文档始终与新版本保持最新。
nextjs.org/learn 改进
nextjs.org/learn 网站是一个交互式学习体验,它指导您逐步了解 Next.js 默认提供的许多功能。
完成每个课程后,您将获得积分奖励。有时,课程甚至可能包含测验,以强化您对课程的理解。
为了跟踪此进度以及您收集的积分,我们之前要求用户使用其 GitHub 帐户登录。
最近,我们取消了此限制,现在所有课程都无需登录即可访问。允许您立即在 nextjs.org/learn 上开始学习 Next.js。
新的 API 路由课程
添加了一个新课程,解释了使用 Next.js 创建 API 端点以及如何使用SWR获取它的基础知识。
特别感谢 Next.js 社区成员Amandeep Singh为贡献此新课程。
未来
我们将根据用户反馈持续改进和迭代文档。您可以期待有关 Next.js 帮助您解决的高级和低级概念的新部分。
如果您对新文档有任何反馈,您可以使用 nextjs.org/docs 上每个页面底部的反馈输入。
我们欢迎社区对文档的任何贡献。一个好的起点是 GitHub 上的“Good first issue”标签。