Giter Site home page Giter Site logo

documentr's Introduction

Documentr

Documentr is a documentation generator that is inspired by the Rails Guides. Basically, I've had the need for a long time to create documentation for various projects, and found there weren't really any good solutions out there. One day, while perusing the Rails Guides reading about Rails 3, it occurred to me that not only were they sexy, but they are laid out and organized quite well.

So, I grabbed a markdown parser and the Symfony YAML component, and whipped up Documentr. I'm currently working on getting an official site and documentation set up for it, but if you're super-anxious to see what it can do you can grab a copy of the repo, tweak the documentr file a bit to find the stuff in src, and then run it in the sample directory. You should get the gist of things. If not, sit tight, I'm gonna have official docs soon.

Credits

This program is inspired HEAVILY by the Rails Guides.

It's also made possible by the following two libraries:

License

This software is licensed under the MIT License, so have at it :)

documentr's People

Contributors

masterexploder avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Forkers

adrienne

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.