# demo-antora

**Repository Path**: consolelog/demo-antora

## Basic Information

- **Project Name**: demo-antora
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-05-28
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

= Antora 脚手架

== 快速开始

=== 使用 NodeJS 的方式生成文档(推荐)

----
yourProjectName=test-project
git clone https://gitee.com/consolelog/demo-antora.git
mv demo-antora ${yourProjectName}
cd ${yourProjectName}
npm install
npm run build-doc
----

=== 使用 antora/cli 的方式生成文档

----
yourProjectName=test-project
git clone https://gitee.com/consolelog/demo-antora.git
mv demo-antora ${yourProjectName}
cd ${yourProjectName}
antora antora-playbook.yml
open docs/index.html
----

== 示例页面

https://consolelog.gitee.io/demo-antora

== 目录结构

* docs(文档最终生成的目录)
** _ 静态资源目录
* document1(文档1)
** antora.yml(文档1配置文件)
** modules
*** ROOT(文档1第一部分)
**** nav.adoc(第一部分左侧导航)
**** pages(详细目录)
***** section1.adoc(章节1)
***** section2.adoc(章节2)
* document2(文档2)
* supplemental-ui(默认模板以及静态资源目录)
* antora-playbook.yml(文档全局配置文件)

== 修改过的文件

示例中 `v1.0.0` 版本匹配的是 `git` 仓库中的 `1.0.0` 分支，是 https://gitlab.com/antora/antora-ui-default[官方默认的UI]示例；

master分支是修改过的，如果不需要，则可以检出1.0.0分支后自行修改：

* footer-content.hbs
* head-title.hbs
* header-content.hbs

== 官方地址

https://antora.org/[官方网站]

https://gitlab.com/antora/antora[源码地址]

https://docs.antora.org/[官方文档地址]