跳到主要内容

1 篇博文 含有标签「技术分享」

分享技术上遇到的问题,或者分享一些技术上的内容

查看所有标签

使用Docusaurus 重构博客

· 阅读需 3 分钟
Embrace
HKBN Senior Programmer

为什么重构博客?

旧的博客架构使用 WordPress 后续经过第一个版本重构更换为了 Hugo。

Hugo 框架在博客方面表现不俗,但是对于技术文档来说,Hugo 的功能有限。

我想把我的技术知识分享给社区,所以决定使用 Docusaurus 构建一个博客。

Docusaurus 可以兼容博客和文档,构建速度快,不依赖于Go 语言。

创建一个博客,使用 Docusaurus 构建一个静态网站。

Docusaurus 是什么?

⚡️ Docusaurus 将帮助您在短时间内构建一个美观的文档网站。

💸 构建自定义技术栈成本高昂。相反,您可以专注于您的内容,只需编写 Markdown 文件。

💥 准备好探索更多了吗?使用高级功能,如版本控制、国际化、搜索和主题定制。

💅 查看最棒的 Docusaurus 网站以获取灵感。

🧐 Docusaurus 是一个静态网站生成器。它构建了一个单页应用,具有快速的客户端导航,充分利用 React 的强大功能使您的网站具有交互性。它提供开箱即用的文档功能,但也可用于创建任何类型的网站(个人网站、产品、博客、营销着陆页等)。

Docusaurus 的优势

⚛️ 采用 💚 和 React 构建
使用 React 进行扩展和定制
通过提供您自己的 React 组件,完全控制您站点的浏览体验
🔌 可插拔
使用基本模板启动您的站点,然后使用高级功能和插件
开源您的插件以与社区共享

✂️ 开发者体验
立即开始编写您的文档
统一的配置入口点,使其更易于贡献者维护
热重载,在更改时实现闪电般的增量构建
基于路由的代码和数据分割
轻松发布到 GitHub Pages、Netlify、Vercel 和其他部署服务
我们的共同目标——帮助您的用户快速找到他们需要的东西,并更好地了解您的产品。我们分享最佳实践,帮助您正确而良好地构建您的文档网站。

🎯 SEO 友好
HTML 文件为每个可能的路径静态生成。
页面特定 SEO,帮助您的用户直接访问与他们当前问题相关的官方文档。

📝 由 MDX 提供支持
通过嵌入在 Markdown 中的 JSX 和 React 编写交互式组件。
在实时编辑器中分享您的代码,让您的用户立即爱上您的产品。

🔍 搜索:您的整个站点都可搜索。
💾 文档版本控制:帮助您使文档与项目发布保持同步。

🌍 国际化 (i18n):将您的站点翻译成多种语言环境。

Docusaurus v2+ 天生就对所有用户具有无障碍访问性,并且速度极快。

⚡️ 闪电般快速。Docusaurus v2+ 遵循 PRPL 模式,确保您的内容加载速度惊人。
🦖 无障碍。注重无障碍性,使您的网站对所有用户都同样可访问。

快速开始

创建一个新的 Docusaurus 站点并按照非常简短的嵌入式教程进行操作。

安装 Node.js 并创建一个新的 Docusaurus 站点

npx create-docusaurus@latest my-website classic

启动站点

cd my-website
npx docusaurus start

默认启动在端口3000