你在找Asciidoctor文档还是AsciiDoc语言文档吗?它们已经搬家了!你可以在 https://docs.asciidoctor.org 查看发布的文档。要提交问题或pull request到Asciidoctor或AsciiDoc文档,请分别访问 Asciidoctor repository 或 AsciiDoc Language repository。 |
这是https://asciidoctor.org[Asciidoctor项目]的项目网站。该站点是用AsciiDoc编写的,由https://github.com/foundation/foundation-sites/tree/v4.3.2[Foundation 4]进行样式设计,通过Awestruct进行构建,并托管在https://www.netlify.com[Netlify]上。
关于如何安装Awestruct及其依赖项的说明,请参见下面的[安装Awestruct]部分。
在本地预览网站
要在本地预览网站,只需运行默认的rake构建任务:
$ rake
默认的rake构建任务是`preview`,所以你实际输入的是:
$ rake preview
preview` 任务只是直接调用开发模式下的 Awestruct 的一种简短方式:
$ awestruct -d
现在访问 http://localhost:4242 预览网站。
为了从一个干净的状态重建网站,将`--force`标志传给`preview`任务:
$ rake preview[--force]
你可以使用前一个命令中的语法通过任何标记传递给Awestruct。
如果你只是想要生成网站,请运行:
$ rake gen
添加并提交文件
添加新文件(例如新的博客条目或图片):
$ git add news/news-slug.adoc
对目录中所有新文件(它只影响新文件,跳过已经提交的文件)
$ git add news/
提交所有标记为待提交的文件,包括刚刚添加的新文件:
$ git commit -m 'your message here'
提交所有已更改的文件,即使它们没有被标记为待提交的文件:
$ git commit -a -m 'your message here'
确保没有任何"未跟踪"或"已修改"的文件:
$ git status
你应该看到:
nothing to commit (working directory clean)
现在你已经准备好部署了。
安装 Awestruct
首先,安装 RVM。请相信我。
$ curl -#L https://get.rvm.io | bash -s stable --ruby
接下来,为了处理Asciidoctor网站,设置一个RVM gemset。
$ rvm use 2.7 --create
在这一点上,你可以直接安装Awestruct,但由于网站构建有一些额外的依赖性,最好让bundler来处理安装。Bundler同样会确保当你运行Awestruct时,你正在使用每个gem的正确版本。
$ bundle --path=.bundle/gems
你现在是Awestruct!
托管
这个网站托管在Netlify上,域名为asciidoctor.org。它由docbot@asciidoctor.org账号以及其他Asciidoctor管理员管理。
部署
Netlify还负责生成和部署网站。部署通过默认分支的git仓库上的一个webhook触发。部署作业执行以下命令:
$ rake deploy:netlify
在Netlify配置中,Ruby的版本是通过设置一个环境变量来确定的。
asciidoctor.org 的部署日志可以在 https://app.netlify.com/sites/asciidoctor/deploys 查看。
域名系统
有两条DNS记录将asciidoctor.org和www.asciidoctor.org指向Netlify服务器:
@ 3600 IN A 104.198.14.52 www 3600 IN CNAME asciidoctor.netlify.com.
Netlify服务器会自动设置一个重定向,将www.asciidoctor.org的流量指向asciidoctor.org。
TLS证书(https)
TLS证书对于asciidoctor.org和www.asciidoctor.org的签发是通过[Let’s Encrypt](uri-letsencrypt)完成的,并且是由[Netlify](uri-netlify)管理的。
使用以下方法验证证书是否有效:
$ curl -vI https://asciidoctor.org
在“Server certificate
”部分下查找`CN=asciidoctor.org`。
感谢Netlify,当证书接近其到期日期时,将会自动重新生成。
许可证
此仓库中的源代码根据MIT许可证条款授权。请查看链接:LICENSE[]以找到完整的许可证文本。
位于[.path]_docs/_文件夹中的文档内容,在https://creativecommons.org/licenses/by/4.0/[Creative Commons Attribution 4.0 International License](CC-BY-4.0)的条款下提供。
查看NOTICE以获取额外的许可证、版权和商标信息。