{"repo":"launchany/mvp-template","free":true,"listed":false,"github":"https://github.com/launchany/mvp-template","clone":"git clone https://github.com/launchany/mvp-template.git","description":"Template for a minimum viable API developer portal, based in Jekyll","language":"SCSS","stars":84,"topics":["api-documentation","api","jekyll-template","jekyll"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"Minimum viable portal (MVP) template for APIs This is a fill-in-the-blanks template for a minimum viable API portal that contains a getting started guide and a API reference documentation. Replace all of the [prompts in brackets] with content that's specific to your API. When you've replaced all the bracketed prompts, you'll have the essentials documented sufficiently to help people use your API. If something in this template doesn't make sense for your API, delete it! And likewise, add any sections you need based on your API's particulars. We hope our suggestions in this template will spark more ideas about documenting features of your API to help users consume it. Here's the template demo page: https://launchany.github.io/mvp-template/. Most of the content is written in Markdown, although the homepage is written in HTML. The template itself is a Jekyll site that you can use with gh-pages. If you want to run your docs on gh-pages, here's a guide by Jonathan McGlone to help you get set up: http://jmcglone.com/guides/github-pages/. Clone this project Clone this project to get a copy of the template that you can update and personalize. Optional: Run a local copy Here are GitHub's instructions for running a local copy: https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/. Files to update These are the individual files to update with details about your own API. mvp-template/ config.yml Site settings: title, email, description, baseurl, url, git ","default_branch":null,"files":null,"tree":[],"storefront":"/r/launchany","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/launchany/mvp-template/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}