asciidoctor.org

Project site for Asciidoctor, composed in AsciiDoc, styled by Foundation, baked with Awestruct and published by Travis CI.

For instructions on how to install Awestruct and its dependencies, refer to the section Install Awestruct below.

To preview the site locally, simply run the default rake build task:

The default rake build task is preview, so you’re effectively typing:

The preview task is just a short way of invoking Awestruct in development mode directly:

Now visit http://localhost:4242 to preview the site.

To rebuild the site from a clean state, pass the --force flag to the preview task:

You can pass any flag through to Awestruct using the syntax in the previous command.

If you just want to generate the site, run:

Add new files (such as a new blog entry or image):

or all new files present in a directory (it only affects new files, skips files already committed)

Commit all files marked to be committed, including new files that were just added:

Commit all files that have changed, even if not marked to be committed:

Make sure there are no files that are "untracked" or "modified":

You should see:

Now you are ready to deploy.

The following commands will push changes (git push), clean build the site (--force -g) using the production profile (-P production), then deploy it to github pages (--deploy):

Or simply run the prepared rake build task (to deploy locally):

Or just push and let Travis CI do the work of deploying the site:

If you want to push without triggering a publish, add the following to the commit message:

First, install RVM. Trust me on this.

Next, setup an RVM gemset for working with the Asciidoctor site:

At this point, you could install Awestruct directly, but since the site build has some additional dependencies, it’s best to let bundler handle the installation. Bundler will also ensure that you are using the correct versions of each gem when you run Awestruct.

You’re now Awestruct!

The site runs on the domain name asciidoctor.org, which is specified in the CNAME file. The GitHub server automatically sets up redirects that point from www.asciidoctor.org to asciidoctor.org.

See the following help page for more details: https://help.github.com/articles/setting-up-a-custom-domain-with-github-pages