clojure-site's Introduction

README

This web site is an open-source repository of content about the Clojure programming language and its greater ecosystem, hosted at http://clojure.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/clojure-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.6.5:

curl -L -O https://dl.bintray.com/jbake/binary/jbake-2.6.5-bin.zip (or download this file with your browser)
unzip -o jbake-2.6.5-bin.zip
Add jbake-2.6.5-bin/bin to your system PATH

To build the site:

Retrieve the content:

git clone https://github.com/clojure/clojure-site.git (or your own fork)
cd clojure-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://clojure.org/clojuretheme.zip (or download this file with your browser to the clojure-site directory)
unzip -o clojuretheme.zip

Generate the pages:

jbake -b - 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 Eclipse Public License v1.0 unless otherwise noted. To submit a pull request or other contribution, you must sign the Clojure Contributor Agreement.

clojure-site's People