Code Monkey home page Code Monkey logo

hotdocs's Introduction

HotDocs 🌭

Flame-grilled API Documentations

What is HotDocs?

HotDocs is a simple template for API Documentations. You just have to edit the data.json file and you are good to go!

How can I use it for my Project? (aka. Installation)

  1. Download or clone this repo.
  2. Edit the data.json file and insert your API details (endpoints, etc.)
  3. For each of your endpoints, add a file with an example response in the folder example-responses
  4. You're done! Open the index.html file in your Browser and enjoy your beautiful-looking API Documentation!

Demo

You can have a look at an Example API Documentation here.

Frequently Asked Questions

Why does this look so good?

Because of Bulma! Bulma is a free, 100% mobile responsive CSS Framework!

Why did you chose this name?

I guess I was hungry. Sorry about that.

This is cool

That's not a question. But thank you.

But generating all the content with JavaScript is bad for SEO!

I know. Maybe I come up with a better soulution to do this in the future. Stay tuned!

What techniques are used under the hood?

Just jQuery and Bulma. That's it.

Why did you made this?

I wanted to have a simple way to create good looking API Documentations for my projects without hard-coding everything.

Can I use this for my API Documentations?

Of course you can!

Do I have to give credits for using HotDocs?

No you don't have to. I mean it would look wired if someone would read "powered by hotdocs 🌭" somewhere on your site, wouldn't it?

Who made this?

I made this. You can contact me on Twitter if you want. 👋

hotdocs's People

Contributors

anthemaker avatar

Stargazers

avatar avatar avatar avatar avatar

Watchers

avatar avatar

Forkers

purplefoxhost

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.