koa-rest-api-boilerplate icon indicating copy to clipboard operation
koa-rest-api-boilerplate copied to clipboard

Published 20 hours ago • verified publisher icon posquit0

Hosting the web based documentation

Open posquit0 opened this issue 6 years ago • 0 comments
trafficstars

Problem

  • README.md is not good to include more detail content. Hosting web-based documentation can be a good solution. There is no hosting cost if we use static web generator and free hosting provider such as GitHub Pages, Netlify.

Solutions

Static Web Generators

Client-side Rendered

  • docsify
    • Smart full-text search plugin
    • Multiple themes
  • docute
    • Leveraging the power of Markdown and Vue
    • Extensible plugin system, plenty of official and community plugins
  • docusaurus

posquit0 avatar Jul 08 '19 16:07 posquit0