Skip to content

clojure-emacs/clojuredocs-export-edn

Repository files navigation

clojuredocs-export-edn

build Dependencies Status

A simple tool that converts ClojureDocs's clojuredocs-export.json to EDN format, and publishes the EDN export (in several variants) to this repository daily.

Why?

Because ClojureDocs doesn't have an official API and provides only a JSON export of its data currently. This makes it harder for tools to leverage ClojureDocs and the EDN exports aim to bridge that gap.

This EDN data is used by libraries like Orchard to fuse ClojureDocs and the standard Clojure documentation.

Exported Data

The EDN data is made available in several variants:

  • A EDN file containing all the data from the JSON export is here.
  • A compact EDN file (it doesn't include data about edits that were made to the data, only its current state) is here.
  • A compact minified EDN file (it strips all the optional whitespace) is here.

Probably most people will be best served by the final variant (export.compact.min.edn).

Running the Exporter

You can also run the export procedure manually like this:

$ lein run

The fresh exports will be placed under exports/.

License

Copyright © 2019-2020 Masashi Iizuka, Bozhidar Batsov

This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at http://www.eclipse.org/legal/epl-2.0.

This Source Code may also be made available under the following Secondary Licenses when the conditions for such availability set forth in the Eclipse Public License, v. 2.0 are satisfied: GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version, with the GNU Classpath Exception which is available at https://www.gnu.org/software/classpath/license.html.

About

Daily EDN exports of ClojureDocs's database.

Topics

Resources

License

Stars

Watchers

Forks