Docusaurus 是 Faecbook 专门为开源项目开发者提供的一款易于维护的静态网站创建工具,使用 Markdown 即可更新网站。青小蛙实验了一下,构建一个带有主页、文档、API、帮助 以及博客页面的静态网站,真的没用上 5 分钟。@Appinn

来自微博好友 @Easy 同学的推荐:

FB 搞了一个专门给开源项目架网站用的 docusaurus ,用 Markdown 写,生成静态网站,可以发布到 GitHub pages。logo 还挺萌的。

说了只需要五分钟,那么来看一下怎么个 5 分钟大法:

首先,去 Vultr (此链接带返利) 开一台最便宜的 VPS,目前只有 5 刀款了,青小蛙幸运的开到了可用的日本服务器(Ubuntu)。

然后安装 npm,这里青小蛙走了弯路,因为 apt install npm 安装的版本过低,于是使用下面几句就可以更新到最新版本了:

npm install -g npm
npm install -g n
n stable
ln -sf /usr/local/n/versions/node/9.2.1/bin/node /usr/bin/node

然后,就可以安装 Docusaurus 了,其实官网有教程啦:

git clone https://github.com/facebook/Docusaurus.git
cd Docusaurus
npm install --global docusaurus-init
docusaurus-init

好了,已经装完了,配置一下,先用 demo 跑起来:

在 Docusaurus 目录下,将 docs-examples-from-docusaurus 改名 docs,进入 website 目录,将blog-examples-from-docusaurus 改名为 blog。

然后,在 website 目录中执行 npm start,Docusaurus 就会顺利的运行在 3000 端口了,直接访问 ip:3000,就能看到下面的页面了:

嗯,非常简单,所有内容由使用 markdown 书写的 .md 文档构成,修改起来也简单,同样官方提供了教程,比如修改 website/siteConfig.js 文件就可以更改标题、描述内容。

有开源项目,又懒得自己写主页的同学,可以去 Docusaurus  试试啦。

后记:青小蛙最终删掉了 Vultr 的测试机器,花费 0.02 刀,嗯。


©2017 青小蛙 for 小众软件 | 加入我们 | 投稿 | 订阅指南 | 反馈 | 代理(优惠码 Appinn)
b27c41ad47c2611d60d7452a4c02dd52
Site Meter

apppackge:

Related Posts

GreaseMonkey

简悦 · 轻阅版 – 支持 Safari、Edge 的浏览器沉浸式阅读模式工具[ UserScript 脚本]

简悦 是一款浏览器沉浸式阅读扩展,开发者逐一适配了 240+ 个网站,只为让用户更好的阅读。之前已「原生」支持 Chrome 与 Firefox,勤奋的开发者更是发布了使用 UserScript 脚本的简悦 · 轻阅版,让 Safari、Opera、Microsoft Edge、Opera、Dolphin 等支持 UserScript 的浏览器都可以使用简悦了。@Appinn 与插件版本相比,UserScript 版本能够让加载速度更快,并且可以导入 简悦 原版的配置。 也就是说,你完全可以在 Chrome、Firefox 上卸载插件版本,而使用 UserScript 版本。 安装方式: 安装 Tampermonkey 并选择对应浏览器的版本; 进入 https://greasyfork.org/zh-CN/scripts/39998,并选择 安装; 完成。 要开启沉浸式阅读,只需要在打开的网页上输入快捷键 AA(双击 A)即可。 简悦 · 轻阅版官网:http://ksria.com/simpread/#lite 相关阅读 「简悦」离它的小目标只差一步了,为你提供沉浸式的 Chrome 阅读体验 TDP Read more…

iOS

小决定 – 选择恐惧症克星,在 iPhone / iPad 上用「大转盘」做决定

小决定 是一款 iOS 上的,用来帮你随机做出决定的小应用,来自房贷计算器 小房贷 开发者的新作。@Appinn 这种大转盘,青小蛙见得最多的地方就是 – 饭店啊,吃饭完抽个奖,看看能打几折… 不过 小决定 的转盘设计挺漂亮的,界面简洁、有旋转音效和选中音效,除了不能模拟手动旋转转盘需要点击中间的按钮外,挺有趣的。 如果能设计根据 3D Touch 来决定旋转力度,就更有趣了。 内置了不少模板,并且有现成的选项。青小蛙建议添加一个保存每次抽奖结果的功能,以备待查 免费版本支持三个决定,想要更多的只需 3 元解锁。 相关阅读 20090624 晚间软闻 联系我们 江湖任我行[周末游戏] 20090713 晚间软闻 2011年小日历 – 打印属于自己的日历 ©2017 青小蛙 for 小众软件 | 加入我们 Read more…

iOS

Just Focus – 用 Unsplash 做背景的漂亮番茄钟应用 [iOS/macOS]

Just Focus 是一款新鲜可口的番茄钟应用,iOS 版本刚刚发布,用来帮助用户通过番茄工作法在 25 分钟内放下手机、专注工作,再休息 5 分钟,再继续。使用了来自 Unsplash 的漂亮照片作为背景,能够劳逸结合的提高工作效率。@Appinn Just Focus 的 macOS 版本已经有两年历史了,那是一款同功能的工具。 青小蛙一直没有成功的实践番茄工作法,其实主要还是干扰太多…想要避免干扰还是需要强大的自控力。 Just Focus 可以自定义工作与休息时间,并不局限于传统的工作 25 分钟,休息 5 分钟模式。 可以设置提醒音效、过长动画,并且能够通过 3D Touch 来查看壁纸。还有屏幕常亮功能,以及一个十分贴心的监测到屏幕向下就变暗的省电模式。 另外,在强制退出又返回后,Just Focus 会给你一个提示: 不知道这是不是功能介绍里所说的「* 强制留在 Just Focus 应用内,减少玩手机的干扰」,因为这样你是得不到数据统计的 喜欢简洁、优雅风格的同学,可以试试这款番茄钟工具。 Read more…