Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Hosting the web based documentation #42

Open
posquit0 opened this issue Jul 8, 2019 · 0 comments
Open

Hosting the web based documentation #42

posquit0 opened this issue Jul 8, 2019 · 0 comments
Assignees
@posquit0
Labels
enhancement
Milestone
v3.0.0

Comments

@posquit0
Copy link
Owner

posquit0 commented Jul 8, 2019 •
edited

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 posquit0 pinned this issue Aug 11, 2019
@posquit0 posquit0 added this to the v3.0.0 milestone Aug 11, 2019
@posquit0 posquit0 self-assigned this Aug 11, 2019
@posquit0 posquit0 mentioned this issue Aug 15, 2019
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@posquit0 posquit0

Labels
enhancement
Projects
None yet
Milestone
v3.0.0
Development

No branches or pull requests
1 participant
@posquit0