Set-ExecutionPolicy Bypass -Scope Process -Force; iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))

choco install docfx -y

Notes

• 安装完docfx之后需要重启powershell,才会有docfx命令

# 构建文档
docfx build

# 构建文档同时本地预览
docfx build -s

# 本地预览文档
docfx serve

Notes

• 更多关于docfx工具使用教程的请参考

我们欢迎所有有能力的开发者为surging社区做出自己的贡献,为surging的发展贡献自己的力量。您可以通过qq群或是issues向作者申请成为文档作者。我们会将文档的贡献者显示在开发者文档相关页面,对所有做出贡献的开发者表示感谢。

在./docs/toc.yml新增文档目录，并在首页./docs/index.md中创建相关的链接。

使用markdown编写开发者文档,将文档存放到相关模块的目录下。关于文档写作规范请参考。

发起pr后,经作者审核通过,将会合并到主分支。

欢迎开发者向社区投稿关于surging或是微服务相关的博客,您可以选择同时发表到其他平台,但是必须是原创的。请将相关的博文存放在./docs/blogs目录下,并向社区提交PR。