前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >Docusaurus2 快速建站,发布 GitHub Pages

Docusaurus2 快速建站,发布 GitHub Pages

作者头像
GoCoding
发布2021-05-06 14:40:03
1.3K0
发布2021-05-06 14:40:03
举报
文章被收录于专栏:GoCoding

Docusaurus2 可快速搭建文档、博客、官网等网站,并发布到 GitHub Pages, Serverless 等。

我们只需 Markdown 写写内容就行,也可直接编写 React 组件嵌入。而 SEO、搜索、版本等都友好支持了。

另外重要的一点是此项目是 Facebook 开源维护的,他们自己也在用,所以质量、长久性能有所保证。

  • 代码:https://github.com/ikuokuo/start-docusaurus2
  • 演示:https://ikuokuo.github.io/start-docusaurus2/ ?

前提准备

  • Node.js version >= 10.15.1
  • Yarn version >= 1.5
代码语言:javascript
复制
❯ node -v
v12.18.4

❯ yarn version
yarn version v1.22.10

创建项目

代码语言:javascript
复制
# npx @docusaurus/init@latest init [name] [template]
npx @docusaurus/init@latest init my-website classic

运行输出:

代码语言:javascript
复制
Success! Created my-website
Inside that directory, you can run several commands:

  yarn start
    Starts the development server.

  yarn build
    Bundles the app into static files for production.

  yarn deploy
    Publish website to GitHub pages.

We suggest that you begin by typing:

  cd my-website
  yarn start

Happy hacking!

运行应用

代码语言:javascript
复制
cd my-website/
yarn start

访问 http://localhost:3000/start-docusaurus2/ 本地地址。

发布到 GitHub Pages

修改 docusaurus.config.js

代码语言:javascript
复制
module.exports = {
  title: 'My Site',
  tagline: 'The tagline of my site',
  url: 'https://ikuokuo.github.io',
  baseUrl: '/start-docusaurus2/',
  onBrokenLinks: 'throw',
  favicon: 'img/favicon.ico',
  organizationName: 'ikuokuo',
  projectName: 'start-docusaurus2',
  ...
};

发布:

代码语言:javascript
复制
cd my-website/
GIT_USER=ikuokuo USE_SSH=true yarn deploy

访问 https://ikuokuo.github.io/start-docusaurus2/ 在线地址。

发布到 Serverless

本文参与 腾讯云自媒体同步曝光计划,分享自微信公众号。
原始发表:2021-01-14,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 GoCoding 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 前提准备
  • 创建项目
  • 运行应用
  • 发布到 GitHub Pages
  • 发布到 Serverless
相关产品与服务
Serverless
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档