middleman-liaison

Liaison

Liaison is a fancier sounding name for a Middleman; it is also a heavily opinionated Middleman project, which is setup with HAML and Sass (instead of ERB & Less), and preconfigured with the Bootstrap framework, Font-Awesome and GitHub Octicons for icons, Kramdown for rendering markdown content, and Rouge syntax highlighting for all of your code highlighting needs.

If you agree with this collection of tools for building websites, the Liaison project is intended to make it really easy to jumpstart new middleman projects.

Getting started

Clone the repo, then:

cd liaison
bundle install
bundle exec middleman

Now go visit http://localhost:4567 from your browser. If you see a message that says "MIDDLEMAN IS WATCHING" you're all set! Click the "Example Documentation" button to view rendered Markdown content.

License(s)

Please refer to the corresponding project licenses for the latest information regarding their licensing requirements. For reference, here is a summary of all licenses used in teh Liaison project:

• The Liaison project (like Middleman) is released under the MIT License.
• Bootstrap is released under the Apache 2.0 license.
• FontAwesome
  • Fonts are released under SIL OFL 1.1 (Open Font License).
  • CSS, LESS and SASS files are released under the MIT License.
  • Documentation is released under the Creative Commons BY 3.0 License
• GitHub Octicons
  • Fonts are released under SIL OFL 1.1 (Open Font License).
  • Code is released under the MIT License.