🌐 Asciidoctor project site. Composed in AsciiDoc. Baked with Awestruct.
CSS XSLT HTML Ruby JavaScript
Switch branches/tags
Nothing to show
Permalink
Failed to load latest commit information.
_archive initial Awestruct-based site and build Mar 21, 2013
_config update list of contributors Jul 7, 2017
_ext build tags if Awestruct is run in development mode w/ generate-on-acc… Aug 18, 2017
_layouts link GitHub icon to project repository if uri-project-repo attribute … Nov 25, 2016
_partials build tags if Awestruct is run in development mode w/ generate-on-acc… Aug 18, 2017
docs Update API docs link for Ruby and Javadoc (PR #710) Aug 20, 2017
fonts upgrade to Asciidoctor 1.5.4 Feb 24, 2016
images French post to start with asciidoctor tools Apr 4, 2016
javascripts resolves #664 add "view result" link to table examples in quick ref (PR May 5, 2017
man use docs layout for man page Dec 23, 2016
news Fix Asciidoctor.js example in the 2014-08-23 news (PR #642) Dec 30, 2016
release-notes credit Anton Moiseev for AsciiDoc language support for Atom Aug 15, 2014
stylesheets upgrade site to Asciidoctor 1.5.6.1 (PR #704) Aug 7, 2017
.awestruct_ignore add Dockerfile for creating an image to build the site Aug 28, 2016
.editorconfig Remove trailing whitespace from docs. (PR #214) Dec 26, 2016
.gitignore Add `.idea` Directory to `.gitignore` File Mar 1, 2016
.ruby-version upgrade site to Asciidoctor 1.5.6.1 (PR #704) Aug 7, 2017
.travis.yml use .bundle/gems as Bundler path in CI Aug 16, 2017
CNAME initial Awestruct-based site and build Mar 21, 2013
Dockerfile add Dockerfile for creating an image to build the site Aug 28, 2016
Gemfile upgrade site to Asciidoctor 1.5.6.1 (PR #704) Aug 7, 2017
README.adoc upgrade site to Asciidoctor 1.5.6.1 (PR #704) Aug 7, 2017
Rakefile Remove trailing whitespace from docs. (PR #214) Dec 26, 2016
contributors.html.slim Adds navigation pane (TOC) to documentation pages Mar 27, 2016
humans.txt remove last update from humans.txt until we automate it Oct 31, 2015
index.adoc resolves #707 btn: not button: (PR #708) Aug 15, 2017
news.html.slim Adds navigation pane (TOC) to documentation pages Mar 27, 2016
robots.txt initial Awestruct-based site and build Mar 21, 2013
supporters.html.slim update list of financial supporters Oct 5, 2016

README.adoc

asciidoctor.org Build Status

This is the project site for the Asciidoctor project. The site is composed in AsciiDoc, styled by Foundation 4, baked with Awestruct, and published by Travis CI.

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

Preview the site locally

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

$ rake

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

$ rake preview

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

$ awestruct -d

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:

$ rake preview[--force]

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

If you just want to generate the site, run:

$ rake gen

Add and commit files

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

$ git add news/news-slug.adoc

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

$ git add news/

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

$ git commit -m 'your message here'

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

$ git commit -a -m 'your message here'

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

$ git status

You should see:

nothing to commit (working directory clean)

Now you are ready to deploy.

Deploy the site to GitHub Pages

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):

$ git push &&
  awestruct -P production --force -g --deploy

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

$ rake deploy

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

$ rake push

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

[ci skip]

Install Awestruct

First, install RVM. Trust me on this.

$ curl -#L https://get.rvm.io | bash -s stable --ruby

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

$ rvm use 2.4 --create

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.

$ bundle --path=.bundle/gems

You’re now Awestruct!

DNS records

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.