https://github.com/clojure/clojure-site

clojure.org site
https://github.com/clojure/clojure-site

clojure docs website

Last synced: 7 days ago
JSON representation

clojure.org site

• Host: GitHub
• URL: https://github.com/clojure/clojure-site
• Owner: clojure
• License: epl-1.0
• Created: 2015-11-10T15:12:16.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2025-01-17T18:55:18.000Z (15 days ago)
• Last Synced: 2025-01-19T03:56:02.832Z (14 days ago)
• Topics: clojure, docs, website
• Language: HTML
• Homepage: https://clojure.org
• Size: 16.9 MB
• Stars: 250
• Watchers: 33
• Forks: 273
• Open Issues: 62
• Metadata Files:
  • Readme: README.adoc
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
= README

Alex Miller

2015-10-19

:jbake-type: page

:toc: macro

This web site is an open-source repository of content about the Clojure programming language and its greater ecosystem, hosted at https://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 https://github.com/clojure/clojure-site/blob/master/content/community/contributing_site.adoc[contribution process].

== Building the Site

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

To https://jbake.org/docs/2.6.5/#installation[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

Copyright © Rich Hickey and contributors

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