Formed in 2009, the Archive Team (not to be confused with the archive.org Archive-It Team) is a rogue archivist collective dedicated to saving copies of rapidly dying or deleted websites for the sake of history and digital heritage. The group is 100% composed of volunteers and interested parties, and has expanded into a large amount of related projects for saving online and digital history.
docs.projectile.mx
The site is generated from the AsciiDoc files in the doc folder of Projectile’s GitHub repo and is published to https://docs.projectile.mx. Antora is used to convert the manual into HTML. The filesystem layout is described at https://docs.antora.org/antora/2.0/component-structure/
To make changes to the manual you simply have to change the files under doc.
The manual will be regenerated manually periodically.
Installing Antora
Installing the Antora is super simple:
$ npm i -g @antora/cli@2.0 @antora/site-generator-default@2.0Check out the detailed installation instructions if you run into any problems.
Building the Site
You can build the documentation locally from this repo.
$ cd docs.projectile.mx
$ antora --pull antora-playbook.ymlAfter you’re done with the initial setup you can use the deploy script to push changes to the site:
./deploy|
Note
|
You’ll need commit access to the repository for this to work. |
To check the generated site you can simply open docs/index.html in your favourite browser.
If you want to make changes to the manual’s page structure you’ll have to edit nav.adoc.