Hopp Doc Gen
API documentation generator CLI for https://hoppscotch.io
Overview:
This document outlines the installation process for Hopp Doc Gen, a tool for generating documentation using Vuepress based on Hoppscotch collections. It provides step-by-step instructions on installation, generating documentation, and deploying it on Netlify.
Features:
- Export Hoppscotch collections from hoppscotch.io/doc
- Generate documentation using a command
- Preview generated documentation
- Deploy documentation on Netlify
- Build documentation files
- Create a GitHub repo for deployment
- Set build command and publish directory
- Deploy documentation on Netlify
Summary:
This document provides a guide for installing and using Hopp Doc Gen, a tool that generates documentation using Vuepress based on Hoppscotch collections. It includes instructions for exporting collections, generating documentation, and deploying it on Netlify. By following the provided steps, users can successfully install and utilize Hopp Doc Gen to create and publish their documentation.
- Documentation
Documentation themes are built specifically for writing technical and product documentation. They are normally written and maintained in Markdown. The often include a navigation menu, search bar, clear headings, semantic document structure and clean typography.