Giter Club home page Giter Club logo

documentarian's Introduction

Documentarian

Simply write beautiful API documentation.

========

image image codecov.io Scrutinizer Code Quality Build Status

This project is a PHP port of the popular Slate API documentation tool.

If PHP is not your thing and you're more into nodeJS, why not give Whiteboard a try?

Documentarian

Check out a Documentarian example API documentation.

The documentation is available at http://marcelpociot.com/documentarian/installation

Slate / Whiteboard compatibility

Since both Documentarian and Slate use regular markdown files to render the API documentation, your existing Slate API documentation should work just fine. If you encounter any issues, please submit an issue.

In depth documentation

For further documentation, read the documentation.

Documentations built with Documentarian

Feel free to submit a PR with a link to your documentation.

Contributors

Slate was built by Robert Lord while at TripIt.

Documentarian was built by Marcel Pociot.

documentarian's People

Contributors

mpociot avatar pashamesh avatar

Watchers

Nelson Melecio 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.