santinic / how2

AI for the Command Line
https://how2terminal.com
MIT License
5.72k stars 156 forks source link

Add a GitHub Pages site #65

Closed koistya closed 2 years ago

koistya commented 8 years ago
  1. Create an orphan gh-pages branch
  2. npm install -g easystatic - installs Easystatic site generator, optimized for GH Pages sites
  3. npm run docs - generates a static site from *.md files in the docs folder and launches it in a browser with "live reload" enabled (via Browsersync)
  4. npm run docs:deploy - pushes the generated static site to gh-pages branch

P.S.: I created this utility for my own OSS projects and though it might be helpful for you as well.

danyshaanan commented 8 years ago

Hi @koistya.

Some points regarding easystatic, which seems like an odd projects in several aspects:

All of this doesn't help to create much confidence in that package or in this PR.

Thanks.

koistya commented 8 years ago

@danyshaanan thanks for your comment! I have addressed some of the issues you mentioned above by creating a CHANGELOG.md file with the list of past and future/planned updates to this static site generator, improved documentation to the project, created tags matching the recently published updates on NPM.