Quickstart Demo

To see AsciiDocsy and Jekyll in action, try building the demo site.

With a Ruby environment in place, these steps will perform a local build of the AsciiDocsy Documentation site.

  1. Clone (or download and inflate) this repo.

    Clone
    git clone git@github.com:DocOps/asciidocsy-docs-www.git
    Download & inflate
    GitHub repository download button
    Use git clone git@github.com:DocOps/asciidocsy-docs-www.git my-asciidocsy-project to name the containing directory something other than asciidocsy-docs-www. Or clone normally and freely rename the directory at any time.
  2. Change to the new directory.

    Example
    cd my-asciidocsy-project
  3. Install Ruby dependencies.

    bundle install

    If Bundler is not installed, gem install bundler, then repeat bundle install.

  4. Generate and serve the demo site.

    bundle exec rake serve

You should now be able to view the site at http://localhost:4000 in any local browser.

You will find the generated files at _site/.