Docsify

[hartmann]

I'd love to see Docsify as a supplement to GitHubPages.

"docsify generates your documentation website on the fly. Unlike GitBook, it does not generate static html files. Instead, it smartly loads and parses your Markdown files and displays them as a website. To start using it, all you need to do is create an index.html and deploy it on GitHub Pages."

[jdaviescoates]

Nice, thanks @hartmann

https://github.com/docsifyjs/docsify/

I also recently came across mdbook which looks nice too:
https://github.com/rust-lang/mdBook

[girish]

It seems to work as-is on the GitHub pages app.

• npm i docsify-cli -g
• docsify init ./docs
• cd docs; git init; git add *; git commit -a
• Then I installed GitHub pages on Cloudron and did a git push

[hartmann]

@jdaviescoates mdBook looks great, too thanks for the tip!

[hartmann]

@girish cool thanks :)! Easier than I thought

[andreasdueren]

@girish said in Docsify:

It seems to work as-is on the GitHub pages app.

• npm i docsify-cli -g
• docsify init ./docs
• cd docs; git init; git add *; git commit -a
• Then I installed GitHub pages on Cloudron and did a git push

Trying this out. You did this in a lamp stack?

[jdaviescoates]

@andreasdueren said in Docsify:

GitHub pages app.

[andreasdueren]

@jdaviescoates Installing this NPM package on top/inside the GitHub pages app?

[jdaviescoates]

@andreasdueren sounds to me like @girish installed it locally then pushed the result to GitHub Pages Cloudron app

@girish said in Docsify:

It seems to work as-is on the GitHub pages app.

• npm i docsify-cli -g
• docsify init ./docs
• cd docs; git init; git add *; git commit -a
• Then I installed GitHub pages on Cloudron and did a git push

I've not tried it but that's what I took from the above.

[andreasdueren]

Oh I understand