Giter VIP home page Giter VIP logo

clojuredocs-export-edn's Introduction

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.

clojuredocs-export-edn's People

Contributors

bbatsov avatar liquidz avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

clojuredocs-export-edn's Issues

HTTP API

I've been thinking lately that it'd be great if we exposed a simple HTTP API to query directly our ClojureDocs EDN export. This would simplify the lives of clients a lot, as they won't have to deal with keeping a local copy of the data and will be able to fetch some data even without Orchard or cider-nrepl.

I guess the simplest API would be - clients request the docs for a symbol and get everything we have about it. A more polished API would allow for clients to specify they want only part of the data for some symbol (e.g. :see-alsos). @liquidz What do you think?

401 Unauthorized on deploying

Deploying operation seems failing recently.
I noticed that logs in CircleCI shows 401 Unauthorized on deploying.

@bbatsov Could you confirm that secrets for NETLIFY_PERSONAL_ACCESS_TOKEN and NETLIFY_SITE_ID are valid?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.