ghpages-blog-cli
v0.1.12
Published
A static site generator for markdown blog articles.
Downloads
1
Readme
ghpages-blog-cli
A command line interface for building markdown blogs on the GitHub pages platform.
Install
npm install -g ghpages-blog-cli
ghpages-blog install-engine
Usage:
ghpages-blog build <dir>
Here <dir>
should be a path to a target blog repository. The CLI is convention based. A blog repository is expected to follow the structure of this template. Specifically:
- There should be a
blog-config.yml
YAML file a the repository root. - Each article should contain YAML metadata at the top of the file.
TODO Details
After building the blog you will need to push the changes to Github and also ensure GitHub pages are enabled for this repo using the '/docs' source (See Repo > Settings > GitHub Pages).