Skip to content

Latest commit

 

History

History
46 lines (28 loc) · 1.96 KB

README.adoc

File metadata and controls

46 lines (28 loc) · 1.96 KB

README

This web site is an open-source repository of content about the ClojureScript programming language and its greater ecosystem, hosted at http://clojurescript.org.

Contributing

If you wish to point out an issue in the site or propose a new page, you can do so by filing a GitHub issue at https://github.com/clojure/clojurescript-site/issues.

If you wish to make a contribution (typo, modification, or new content), you must become a contributor and follow the contribution process.

Building the Site

The site is built using JBake.

To install JBake 2.5.0-SNAPSHOT:

  1. curl -O http://cdn.cognitect.com/clojurescript.org/jbake-2.5.0-SNAPSHOT-bin.zip (or download this file with your browser)

  2. unzip -o jbake-2.5.0-SNAPSHOT-bin.zip

  3. Add jbake-2.5.0-SNAPSHOT/bin to your system PATH

To build the site:

Retrieve the content:

  1. git clone https://github.com/clojure/clojurescript-site.git (or your own fork)

  2. cd clojurescript-site

Retrieve and install the current theme assets (these don’t change very often so you don’t need to do this every time):

  1. curl -O https://clojurescript.org/cljstheme.zip (or download this file with your browser to the clojurescript-site directory)

  2. unzip -o cljstheme.zip

Generate the pages:

  1. jbake - this will create the static site in the output directory

  2. Run jbake -s to serve these pages at http://localhost:8820/index

Terms of Use

Copyright © 2015 Rich Hickey and contributors

All documentation contained in this repository is licensed by Rich Hickey under the Eclipse Public License v1.0 unless otherwise noted. To submit a pull request or other contribution, you must sign the Clojure Contributor Agreement.