docsy
文档了解如何修改master
创建一个新的分支, 修改完成后提交 PR ✅ (请在 PR 内截图对比一下修改前后的效果 & 简要说明, 感谢)Refer: 不熟悉 github-pr 流程的同学, 可以参考贡献流程文档, 最简单的方式是下 github 桌面应用, 会简单方便许多~
PS: 可以参考其他官网的源码, 方便快速了解 docsy 主题结构.
Only 3 steps u can easily to get start~
U should ensure NPM & Hugo binary download url before start, hugo binary must end with “extended” suffix, and we don't need install go env, just download hugo binary is fine
# 0. install npm & hugo if you don't have it # Mac version (0.95 extend) wget https://github.com/gohugoio/hugo/releases/download/v0.95.0/hugo_extended_0.95.0_macOS-64bit.tar.gz # Linux version (0.95 extend) wget https://github.com/gohugoio/hugo/releases/download/v0.95.0/hugo_extended_0.95.0_Linux-64bit.tar.gz # 解压后 hugo 是单二进制文件, 可直接使用, 或推荐放 /usr/bin 及环境变量下. sudo install hugo /usr/bin # 如果 mac 提示没有权限, 你可以直接使用它, 也可以 mv hugo /usr/bin 代替 # 1. download website's source code git clone https://github.com/apache/hugegraph-doc.git website # if download slowly or failed, try the proxy url git clone https://api.mtr.pub/apache/hugegraph-doc.git website # or https://github.do/https://github.com/apache/hugegraph-doc.git # 2. install npm dependencies in project root dir cd website && npm install # 3. just start server in localhost now (Don't need do anything else) hugo server # (optional) if you want modify ip or port, try like this hugo server -b http://127.0.0.1 -p 80 --bind=0.0.0.0
Here we need FE to modify / enhance the css/js/theme config, and we also need to translate doc and website
You can find detailed theme instructions in the Docsy user guide - Content and Customization
config.toml
in the root dir is global configconfig.toml
in the ./themes/docsy
is theme configcontent
dir contains multi-language contents (docs/index-html/blog/about/bg-image), it's the most important dircontent/en
represent english site, we do need translate the doc
in it (可先用 google 翻译, 紧急)content/cn
represent chinese site (需要汉化其中英文部分)We can see some example website & refer to their GitHub source code to reduce time to design
If you run into the following error:
➜ hugo server Error: Error building site: TOCSS: failed to transform "scss/main.scss" (text/x-scss): resource "scss/scss/main.scss_9fadf33d895a46083cdd64396b57ef68" not found in file cache
This error occurs if you have not installed the extended version of Hugo.