Code Monkey home page Code Monkey logo

alchemysite's Introduction

Alchemy Site

Quick Start

Alchemy uses yeoman for scaffolding and work flow and jekyll to actually generate our documentation.

Yeoman

git clone <this repo>
cd <this repo>/site

# Note, you MUST be in the site directory to run the following commands.
# Otherwise you will be running commands from the main alchemy app.

# install node modules
npm install
# install bower depedencies
bower install

#install jekyll, kramdown and code-ray (syntax-highlighting)
gem install jekyll code-ray kramdown

# fire up the develoment server
grunt serve
# package the site to go live
grunt

Jekyll

All of the configurations for the jekyll reside in the _config.yml file and the build process can be run manually with jekyll build.

Jekyll ignores all coffeescript and scss files and lets the other grunt plugins take care of them. It compiles the index file from the .md files in the _documentation collection. The configuration.md file (one of the files in the documentation collection) is generated by the .md files located in _configDocs.

alchemysite's People

Contributors

mdcox-sdm avatar xrd avatar

Watchers

James Cloos avatar Harland Hauger avatar

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.