https://github.com/pwright/arotna.org
A starter repo for Antora - orchestrated from docs/arotna.csv file
https://github.com/pwright/arotna.org
Last synced: about 1 month ago
JSON representation
A starter repo for Antora - orchestrated from docs/arotna.csv file
- Host: GitHub
- URL: https://github.com/pwright/arotna.org
- Owner: pwright
- Created: 2019-04-15T12:55:17.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-04-16T15:23:10.000Z (about 7 years ago)
- Last Synced: 2025-01-12T09:08:06.164Z (over 1 year ago)
- Language: Ruby
- Homepage: https://arotna.netlify.com
- Size: 286 KB
- Stars: 1
- Watchers: 1
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.adoc
Awesome Lists containing this project
README
= Arotna
The goal of Arotna is to get you going with creating a doc site using Antora quickly.
== Requirements
* http://harelba.github.io/q/[q] csv query tool
* https://docs.antora.org/[Antora]
== Tasks
. Clone this repo.
. Change to the `empty` branch
. Edit the following files and replace `arotna` with the code name for your project:
+
----
antora.yml
local-site.yml
----
. Edit the `docs/pages/index.adoc` file to provide an introduction.
. Edit the `docs/arotna.csv` file to structure your site, for example:
+
----
level,prefix,heading,slug,navtext
1,*, User story, user-story, Story
2,**, Breaking changes, breaking-changes, Changes
2,**, New User story, new-story, New
2,**, User story announcements, announcement, Announcements
2,**, Deprecated user stories, deprecated, Deprecations
1,*, Known Issues, known-issues, Known issues
----
+
where:
+
* slug defines the filenames and ids required for your site
* heading defines the pages
* level and prefix define the hierarchy
* navtext defines the short name used in left hand menu
. Run the following command from the root directory of the repo:
+
----
$ ./bin/quick-build.sh local-site.yml
----