文档源文件../content
在仓库目录下corda-docs-portal
,用markdown写成。
HTML 文档输出是使用 Hugo 生成的。您可以使用 npm 和降价编辑器在本地构建和编辑文档。
[hidecontent type="logged" desc="隐藏内容:登录后可查看"]
corda/corda-docs-portal
存储库,并克隆你的分叉。npm install
. 这将安装所有必需的模块以在本地构建文档。content
。hugo server --watch=false
以在本地构建文档。请注意,由于存在一个未解决的 Hugo 错误,该错误会出现在大型网站上,例如docs.r3.com
,目前无法使用动态内容刷新在本地构建文档 - 您需要CTRL-C
在更改内容后再次运行构建。我们希望雨果能尽快解决这个问题!https://localhost:1313
以查看本地构建的文档。使您的分叉与主文档存储库保持同步的最佳方法是upstream
在创建分叉后将其添加为远程。
要添加上游遥控器:
git remote add upstream https://github.com/corda/corda-docs-portal.git
可以使用git remote set-url
命令更改远程的 URL。
查看您的遥控器:
git remote -v
如果您需要删除遥控器:
git remote rm remote-name
要更新您当前的分支,请基于上游远程的最新更改。这将保护任何未合并的提交不被覆盖:
git rebase upstream/main
项目开源地址:https://github.com/corda/corda-docs-portal
[/hidecontent]