Overview

This product is a minimum viable portal (MVP) template for APIs. It provides a fill-in-the-blanks template for documenting an API and includes a getting started guide and API reference documentation. The template is written in Markdown, with the homepage in HTML. It is a Jekyll site that can be used with gh-pages.

Features

• Fill-in-the-blanks template for documenting APIs
• Includes getting started guide and API reference documentation
• Written in Markdown

Installation

To use this MVP template for your API, follow these steps:

1. Clone the project: Clone this project
2. Run a local copy: GitHub’s instructions for running a local copy
3. Update the following files with details about your API:
   • _config.yml: Site settings and theme options
   • _about/index.md: Information about your API and documentation
   • _data/docs.yml: Menu structure for Documentation pages
   • _docs/index.md: Get started and authentication
   • _docs/workflows.md: Workflows
   • _docs/code_samples.md: Code samples
   • _docs/mdreference.md or _docs/openapi.md: Reference and endpoints

Note: If you delete, replace, or rename any files in the _docs folder, make sure to update _data/docs.yml and _includes/topnav.html to reflect your structural changes.

Summary

The MVP template for APIs is a helpful tool for quickly documenting an API. With a fill-in-the-blanks approach, it allows API developers to easily provide essential information for users to consume the API. The template is written in Markdown and can be customized to fit the specific details of the API. Additionally, the template is built with Jekyll and can be used with gh-pages for deployment.