跳到主要内容

如何在不到两小时内将Profilo转换为Docusaurus

· 阅读需 4 分钟

“我和Joel讨论过做一个网站,以及如果一开始就有了网站该有多好。所以我挑战自己添加了Docusaurus的支持。只花了不到一个半小时。我会给你发送一个包含新增内容的PR,你可以看看是否喜欢。你添加文档的工作流程与编辑那些Markdown文件没什么不同。”

——给Profilo团队的便签

这就是使用Docusaurus创建 Profilo 网站的相当简短旅程的故事。

Profilo是一个用于从生产环境收集性能追踪的Android库, 在今年早些时候发布 。该项目 已发布到GitHub ,其中包含少于 少量Markdown文件 来描述其功能,并且没有网站来展示任何品牌和突出logo。手头的任务是将这些现有的文档和logo变成一个网站。

一般来说,使用Docusaurus创建网站时,您需要执行以下操作:

  1. 使用Docusaurus脚本生成模板网站。
  2. 自定义生成的模板文件以满足您所需的网站颜色和项目配置(例如:网站和GitHub链接)。
  3. 创建网站内容:
    1. 添加您的文档和任何支持的资源。
    2. 自定义Docusaurus提供的默认登录页面以满足您的需求。
    3. 配置默认的站点导航文件。
  4. 发布网站并设置未来更改的发布方式。

鉴于我已经有了现有的Markdown文件,我不需要生成核心内容,只需要确保Docusaurus可以通过向它们添加预期的元数据来处理这些文件。因此,大部分工作将包括自定义Docusaurus提供的默认设置。

步骤概述

以下是将现有文档转换为网站所采取步骤的概述。我将在后面的章节中讨论一些设计方面。

设计和颜色:

  1. 从设计师那里获得了所有所需的logo格式。我必须创建一个_.favicon_文件。
  2. 使用http://paletton.com/工具确定了一些可以接受的主要和次要网站颜色——非常方便!

初始网站设置:

  1. 在GitHub上fork了 Profilo项目 ,并创建了fork的本地克隆来设置网站。
  2. 使用 安装说明 创建了初始的Docusaurus网站。
  3. 删除了docs-examples-from-docusauruswebsite/blog-examples-from-docusaurus文件夹,因为这些文件夹将不需要。Profilo已经有我们可以使用的现有文档,目前不需要博客。

内容创建:

  1. docs文件夹中找到的现有Markdown文件添加元数据,例如: