giab
v1.0.8
Published
a tool for "giab" (github issue as blog) guys
Downloads
2
Readme
giab
A tool for "giab" (github issue as blog) guys
This tool will generate an issue(blog post) list in your README.md.
Install
npm install giab
Usage
Go to your repository's root dir
Make sure you have a readme file named README.md
Add placeholder to README.md, like this:
<!--giab:issue_list_start-->
your articles will be shown here
<!--giab:issue_list_end-->
- Add a config file named .giabrc, sample content:
{
"type": "basic",
"username": "simongfxu",
"password": "password here",
"issues": {
"repo": "simongfxu.github.com",
"owner": "simongfxu"
}
}
GitHub token also supported to hide your password.
- Edit .gitignore file in your repository's root dir, add a line
.giabrc
NOTE: this is very important, I do not think you will let everybody know your password.
- Execute the following command
node node_modules/giab
That is all!