Code Monkey home page Code Monkey logo

aeolus-website's Introduction

How to build the Aeolus Project website

Requirements

You need to have Ruby installed, along with the following gems:

  • nanoc (3.3.3 is known to work)
  • haml (3.1.4 is known to work)
  • sass (3.1.16 is known to work)
  • kramdown (0.13.5 is known to work)
  • nokogiri (1.5.2 is known to work)
  • adsf (1.1.1 is known to work)

Depending on your operating system, you may need to add the directory with the "nanoc" executable to your $PATH.

Building the Website

The Aeolus Project website is created using nanoc. It takes a website defined by a set of layouts, templates and content files, runs a count of filters on them and produces a static web structure that can be directly posted to a webserver or displayed in a browser.

To do this, go to the "nanocsite" directory and run "nanoc compile":

$ cd nanocsite
$ nanoc compile

The website will be generated into the "nanocsite/output/" directory.

To view the output, start nanoc's built in web server, then point your browser to http://localhost:3000.

$ nanoc view
$ firefox http://localhost:3000

Nanoc Help

Nanoc has many more commands and options available. You can find out more about them by running:

$ nanoc help

File Structure

  • nanocsite/

  • the Aeolus Project website

  • nanocsite/content/

  • the pages that are displayed on the website

  • nanocsite/content/static-redmine

  • static redmine content (themes, javascripts, etc)

  • nanocsite/layouts/

  • the Aeolus Project website template

  • nanocsite/output/

  • the final version of the site -- this is what you want to view in a web browser

File Types

  • HAML files must have the extension .haml
  • Kramdown files must have the extension .md

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.