Open Source Ecosystems

= README Alex Miller 2016-07-29 :jbake-type: page :toc: macro

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 https://github.com/clojure/clojurescript-site/blob/master/content/community/contributing_site.adoc[contribution process].

== Building the Site

The site is built using http://jbake.org/[JBake].

To http://jbake.org/docs/2.4.0/#installation[install] JBake 2.5.0-SNAPSHOT:

. curl -O http://cdn.cognitect.com/clojurescript.org/jbake-2.5.0-SNAPSHOT-bin.zip (or download this file with your browser) . unzip -o jbake-2.5.0-SNAPSHOT-bin.zip . Add jbake-2.5.0-SNAPSHOT/bin to your system PATH

To build the site:

Retrieve the content:

. git clone https://github.com/clojure/clojurescript-site.git (or your own fork) . 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):

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

Generate the pages:

Note that jbake 2.5.0 requires Java 8. (It will not run properly under Java 9.)

. jbake - this will create the static site in the output directory . Run jbake -s to serve these pages at http://localhost:8820/index

Terms of Use

All documentation contained in this repository is licensed by Rich Hickey under the http://www.eclipse.org/legal/epl-v10.html[Eclipse Public License v1.0] unless otherwise noted. To submit a pull request or other contribution, you must sign the http://clojurescript.org/community/contributing[Clojure Contributor Agreement].