alc-beijing / alc-beijing/alc-site

[官网] 关于alc-beijing官网技术栈更换的讨论

Ouverte
#171 2 commentaires 1 réaction 0 personnes assignées Voir sur GitHub
Langage dominant
JavaScript
Étoiles
80
Forks
34
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

大家好,这是关于alc-beijing的新官网技术栈更换的讨论, alc-beijing官网目前采用的技术栈是[hugo](https://gohugo.io/), 初步计划新官网使用[docusaurus](https://docusaurus.io/).

这里将从Docusaurus的优点,以及我们为什么要更换,迁移成本几个方面说:

## Docusaurus的优点:

### 1. Markdown 驱动

节约时间并专注于文档本身。只需要以 Markdown/MDX 格式撰写文档/博客,Docusaurus 就能自动构建生成静态 HTML 文件。通过 MDX,甚至可以在 Markdown 中嵌入 React 组件。

### 2. 支持 React

通过编写 React 组件来扩展和自定义你的网页布局。利用插件架构,你可以在设计自己的网站的同时,复用 Docusaurus 插件所创建的数据。

### 3. theme 丰富

网站是否美观是非常重要的一部分,Docusaurus 有非常多开源的 [user case](https://docusaurus.io/showcase), 开箱即用, 美观大气, 二开定制也非常方便

### 4. 插件丰富

Docusaurus 有大量的插件可供使用, 如 google-analytics, algolia 等

### 5. 极大的灵活性

由于自身是 Markdown驱动 ,支持 React, 用户可以自定义很多内容, 结合 Docusaurus 已有的能力, 带来极大的灵活性

### 6. 非常适合开源项目建站

Docusaurus 适合于开源项目的官方网站这类的需求,有很多开源项目都使用Docusaurus, 如: [apisix](https://apisix.apache.org/), [seatunnel](https://seatunnel.apache.org/), [streampark](https://streampark.apache.org/)
等.

---

## 我们为什么要更换:

### 1. 老的技术栈提供的能力有限

老的技术栈采用的是hugo ,不可否认 hugo有着非常大的使用人群, 但我实际调查发现. hugo 主打速度快,易用,可配置, 但是本身提供的能力有限, 主题模板,插件等也都相对简单一些, 相比之下 Docusaurus 是一个更加专业的建站工具.

### 2. 对 Docusaurus 比较了解
由于我之前的对 Docusaurus 就有了解,并实际使用过,主导过 [seatunnel](https://seatunnel.apache.org/), [streampark](https://streampark.apache.org/) 官网的初版建设, 所以有一些经验. 能减少很多时间在踩坑上, 相反我对 hugo 并不了解

### 3. 可以很快二开
如果使用Docusaurus, 我们可以基于 Docusaurus 已有的模板, 很快定制化二开一个网站出来, 不失专业又美观

### 4. 学习成本低

我也考虑过大家之前已经熟悉hugo的方式,更换Docusaurus之后是否有学习成本的问题, 这里从两个视角说:

#### 1) 文章投递

对于文章的投递,和之前完全一样,就是一个标准的Markdown文件, 放到指定的文章目录下即可, 没有任何学习成本

#### 2) 网站维护 & 改版

官网的维护和改版,需要稍微看一下Docusaurus的文档, 都是模块化的, 支持标准的html,css和react, 对于开发者来说,学习成本也不大

---

## 技术栈更换成本:

我初步评估了下,技术栈从hugo更换为Docusaurus大致有以下几点:

### 1) 文章迁移成本

老的官网主要内容就是博客文章. 所以大头基本上在文章迁移这一块, 这部分如果文章里没有使用hugo的特有标签和指令,迁移起来应该比较简单

### 2) 一些动态化能力

这个方面属于迁移到新的官网(基于Docusaurus)之后需要面对的问题, 具体: 需要在首页放一些最新的文章,活动等, 这些应该是根据文章活动投递的时间排序取前N生成的, 这部分能力和相关api在 Docusaurus 中是否支持,还需要进一步调研.

----

欢迎大家讨论.

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.