Giter Club home page Giter Club logo

autodoc-index's Introduction

An Indexer for Autodoc Data

When a user or organization has a number of projects that are documented using the autodoc system (https://github.com/tomfaulhaber/autodoc), this project can be used to create a master overview and index.

This is currently being used to document the Clojure core and contrib libraries and you can see the results at http://clojure.github.io.

I have not yet completely generalized this program and don't have any immediate plans to. On the other hand, it ought to be pretty easy to adapt it to your project. Just keep in mind that the Clojure logo and such are copyrighted by Rich Hickey and you'll need to get his permission to use them for uses other than Clojure itself.

License

Autodoc-index is licensed under the Eclipse Public License 1.0 (like Clojure itself) which can be found in the file epl-v10.html at the root of this distribution. This means it can go anywhere Clojure can go.

autodoc-index's People

Contributors

laurio avatar tomfaulhaber avatar

Watchers

 avatar  avatar

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.