Project

greed-summary

0.0
No commit activity in last 3 years
No release in over 3 years
greed-summarygreedlab/greed-summaryHomepageDocumentationSource CodeBug TrackerWiki
generate summary for markdown.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Popularity
Downloads
13,705
Stars
1
Forks
1
Watchers
1
 Releases
Current version
0.1.4
Total releases
5
First release
2016-04-27
Latest release
2016-05-18
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2016-06-17
Reverse Dependencies
0

 Dependencies

Development

bundler
~> 1.11
rake
~> 10.0
 Project Readme

Greed::Summary

generate SUMMARY.md for Github or Gitbook

Installation

$ gem install greed-summary

Usage

greed-summary [OPTION]

-t, --title [string]:
   title ,default 'SUMMARY'

-d, --directory [directory path]:
   target directory path ,default './'

-o, --output [file path]:
   output file path ,default './SUMMARY.md'

-i, --ignore [array]:
   ignore string array ,default '['resource', 'Resource']'

-s, --suffix [array]:
   suffix string array ,default '['.md', '.markdown']'

-S, --style [string]:
   output style ,could be 'github' or 'gitbook', default 'github'

-a, --autotitle:
   auto set file title from file content, set directory title from readme.md file content

-e, --encode:
   url encode

-h, --help:
   show help

-v, --version:
   show version

Example

use

greed-summary -t "Bell's Blog" -i '[scripts,resource,Resource,Publish,_book,docs,node_modules,assets]' -d ${BLOG_DIRECTORY}/ -o ${BLOG_DIRECTORY}/README.md -S github -a

to generate README.md from Blog

License

The gem is available as open source under the terms of the MIT License.