2.6.1

• Added badges 🎉
  • PayPal Donations
  • npm downloads
  • npm version
  • Travis (if there are tests)
  • CodeMentor–you can ping me there if you need help with one of these modules (or help in general).
• Updated the LICENSE year. 🎆

2.6.0

• Added package.json
• Improved the documentation.
• Integrated json2md with blah to get the best flexibility in generating documentation. 💫
• Relicense to MIT and link to the license. ❤️

Regarding the integration of json2md into blah, read this blog post I wrote.

2.5.0

Fixed the license year.

2.4.0

This update is part of the biggest process of cleaning up my GitHub projects:

• Some of the repos were merged with other repos. 🎈
• Obsolete repositories (actually these that didn't have any functionality) were been deleted. 🔥
• Most of them got better documentation using blah configuration. 📖 📚 📝

Changes

• Improved documentation 📝
• Added/updated the the CONTRIBUTING.md file. 📖
• Integrated json2md with blah to get the best flexibility in generating documentation. 💫

Regarding the integration of json2md into blah, read this blog post I wrote.

2.3.0

As of this version, we can define license templates. The licenses are not written in ejs format (like the other templates), and they should be located in the licenses directory. ✨

2.2.0

• Minor fixes in the template files.

2.1.1

• Improvements to CONTRIBUTING.ejs. Thanks, @silviubogan! 🍰

2.1.0

Since .gitignore has a special meaning inside of a git repository and since npm does not include by default the .gitignore files, I renamed the .gitignore template into gitignore (without dot).

Note you may update your blah templates (user and project levels) if you have a .gitignore file -- you have to rename it into gitignore. 🍀

2.0.0

⭐ 🌟 ⭐ 🌟 ⭐ 🌟 ⭐ 🌟 ⭐ 🌟 ⭐ 🌟 ⭐ 🌟 ⭐ 🌟 ⭐ 🌟 ⭐ 🌟 ⭐ 🌟 ⭐ 🌟 ⭐ 🌟 ⭐

Blah 2.0.0

This little shiny tool just got better! In this new release I implemented a lot of new features.

First of all, the command line arguments are parsed using clp - this allows to automatically generate help content for blah --help (or blah -h):

$ blah -h
Usage: blah [options]

Options:
  -i, --init                    Inits the .blah directory.             
  -r, --readme                  Creates the README.md file.            
  -g, --gitignore               Creates the .gitignore file.           
  -l, --license <license>       Generates a LICENSE file with copyright
                                information.                           
  -c, --contributing            Generates the CONTRIBUTING.md.         
  -d, --docs <path>             Generates the markdown documentation   
                                (DOCUMENTATION.md) for input file.     
  -b, --bump-version <version>  Bumps the package.json version.        
  -h, --help                    Displays this help.                    
  -v, --version                 Displays version information.          

Examples:

  $ blah --readme      # generates the README.md file using package.json
  $ blah --gitignore   # generates the .gitignore file
  $ blah --license mit # generates the LICENSE file taking copyright holder information
                       # from package.json or GIT variables
  $ blah --docs index.js # generates DOCUMENTATION.md from index.js, parsing JSDoc comments
  $ blah --bump-version major # bumps the major field of version, in package.json file

Happy Blahing!

Documentation can be found at https://github.com/IonicaBizau/node-blah

So, after installing blah (npm i blah -g), everything starts with reading the help content. In this new release I introduced three levels of templates:

• project templates
• user templates
• default templates

Project Templates

These are stored in the .blah directory of a project. They have the greatest priority when generating documentation. To init the .blah directory you have to run:

$ blah -i
# or
$ blah --init

This will create the .blah directory copying templates from ~/.blah-templates or default templates.

This level of templates is mainly designed for having project related notes in the readme file.

User Templates

They are stored in the ~/.blah-templates folder. If the project templates are missing, then blah tries to use the user templates. These are designed for automating the docs generating for projects.

Default templates

They are stored in the lib/templates folder of this very project. If user templates are missing, then these default templates will be used.

⭐ 🌟 ⭐ 🌟 ⭐ 🌟 ⭐ 🌟 ⭐ 🌟 ⭐ 🌟 ⭐ 🌟 ⭐ 🌟 ⭐ 🌟 ⭐ 🌟 ⭐ 🌟 ⭐ 🌟 ⭐ 🌟 ⭐

Generating docs

• For readme files, you just need to run blah -r and let the magic happen. ✨
• To generate .gitignore, do blah -g.
• To generate the LICENSE file, do blah -l MIT (this will create a copy of the MIT license).
• For CONTRIBUTING.md, run blah -c.
• To generate DOCUMENTATION.md do blah -d lib/index.js (or any other input file)
• To bump the project version, blah -b major (or any of the following: major, minor, patch)

---

This update involved a lot of work. The following packages were added/updated:

• [email protected]
• [email protected]
• [email protected]
• [email protected]
• [email protected] by @mde
• [email protected]
• [email protected] by @cbou
• [email protected] by @AvianFlu
• [email protected]
• [email protected]
• [email protected]
• [email protected]
• [email protected]
• [email protected]
• [email protected]

Before merging, @cbou should release the new version of markdox with some fixes:

• cbou/markdox#34
• cbou/markdox#33

---

I already started to use this new version in generating the documentation for the subdependencies and it works like a charm! 💫

---

Fixes #10, #11, #12, #13, #14, #15, #16, #17, #18. 💥

First stable release

1.0.0

Merge branch 'module'