Skip to content

Latest commit

 

History

History
31 lines (24 loc) · 1.21 KB

README.adoc

File metadata and controls

31 lines (24 loc) · 1.21 KB
    ____  _____ ______       __
   / __ \/ ___// ____/  ____/ /___  __________
  / /_/ /\__ \/ /_     / __  / __ \/ ___/ ___/
 / _, _/___/ / __/    / /_/ / /_/ / /__(__  )
/_/ |_|/____/_/       \__,_/\____/\___/____/

This repository holds the pages for RSF documentation. We are engaged in an effort to regenerate the old JSPWiki pages with AsciiDoc so that they may be maintained with standard version control.

Building

The build script assumes you have the prerequisites installed: asciidoc and git.

./generate-site.sh

The site pages will be created in the root directory from sources in source. Their layout is governed by source/layout.conf.

AsciiDoc

At first blush, AsciiDoc is just Yet Another Markup Language. There are some nice benefits to using it, however:

  1. Like Markdown — a popular favorite — it is human-readable plain text

  2. It offers many more features than Markdown, such as tables, document meta-data, macros, and a variety of block types

  3. In addition to HTML output, it supports PDF, DocBook, EPUB, and others

Website

This system powers http://rsf.github.io