Skip to content
This repository has been archived by the owner on May 5, 2020. It is now read-only.

Commit

Permalink
Bump Version to 0.3.0
Browse files Browse the repository at this point in the history
"Papeete Polar Bear"
  • Loading branch information
killercup committed Feb 10, 2014
1 parent 9321bc1 commit 51c8886
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 32 deletions.
66 changes: 37 additions & 29 deletions Changelog.md
Original file line number Diff line number Diff line change
@@ -1,50 +1,58 @@
# Changelog

## v0.3.0 Papeete Polar Bear

Mon Feb 10 2014

- Add _Thin_ style with bright colors and sharp fonts: [Screenshot](https://f.cloud.github.com/assets/20063/2121121/573a2af8-91d4-11e3-956a-a27ffd9a8635.png)
- Correctly link to latest source files on Github and Bitbucket (git repos)
- Add copyright and license doc tags

## v0.2.6 Dave Thesis

Sat Feb 08 2014

- Add `--indexes` option to generate subdirectory index files (default: `Readme.md` gets rendered as `index.html`)
- Fix doc tags order messing up markdown
- Fix doc tags order messing up markdown
- Automatically retrieve repository URL from `package.json`

## v0.2.5 Oscar Hera

Mon Feb 03 2014

- Adds nice error messages à la [plumber](https://github.com/floatdrop/gulp-plumber)
- incl. file path
- with stack traces on `--verbose`
- Add better page titles
- incl. file path
- with stack traces on `--verbose`
- Add better page titles
- Fixes `index.js` and thus `require('grock')`

## v0.2.4 Jefferson Hemera

Sat Feb 01 2014

- Trim unnecessary newlines from highlighted code
- Fix searching headlines
- Fix searching headlines
- Improve tests and hopefully performance

## v0.2.3 Steel-Eye Demeter

Thu Jan 30 2014

- Render files without extension (treating them as JS)
- Trim HTML from headlines in TOC
- Always skip processing directories
- Don't crash on malformed doc tags
- Trim HTML from headlines in TOC
- Always skip processing directories
- Don't crash on malformed doc tags
- Add more usage information to Readme file

## v0.2.2 Happy Erebus

Thu Jan 30 2014

- Precompile Templates
- Enhances performance
- Styles can use any templating library
- Solarized uses `lodash` templates now (this removes `jade` dependency)
- CoffeeScript 1.7 makes chained function calls more pretty (e.g. in streams and `.pipe`s)
- Enhances performance
- Styles can use any templating library
- Solarized uses `lodash` templates now (this removes `jade` dependency)
- CoffeeScript 1.7 makes chained function calls more pretty (e.g. in streams and `.pipe`s)
- Speed things up a bit by skipping `highlight.js` and `marked` for files without code or comments (e.g. `.md` and `.json`)

## v0.2.1 Louis Hermes
Expand All @@ -59,10 +67,10 @@ Sun Jan 26 2014
Sat Jan 25 2014

- CLI arguments and `.groc.json` compliment each other
- Remove `gulp-util` dependency
- Solarized: Better responsive modes
- Solarized: Nicer directory index handling
- Solarized: Fix file title from headline
- Remove `gulp-util` dependency
- Solarized: Better responsive modes
- Solarized: Nicer directory index handling
- Solarized: Fix file title from headline
- Solarized: Readmes are fist files in directories

## v0.1.2 Dizzy Demeter
Expand All @@ -76,25 +84,25 @@ Mon Jan 20 2014
Mon Jan 20 2014

- Add file path above document, link to currnt file in repository
- Add checkbox lists in markdown (using `[ ]` and `[x]` syntax)
- Add checkbox lists in markdown (using `[ ]` and `[x]` syntax)
- Fix some broken words (using CSS' word-break)

## v0.1.0 Clark Hades

Mon Jan 20 2014

_Initial release._

Features so far:

- Take code files, output html files
- Split code and comments
- Highlight code (even in comments)
- Generate TOC as JSON file
- Render doc tags (like jsdoc)
- CLI docs, `.groc.json` config support
- Default output style
- Based on Solarized
- Searchable file and headline list

Features so far:

- Take code files, output html files
- Split code and comments
- Highlight code (even in comments)
- Generate TOC as JSON file
- Render doc tags (like jsdoc)
- CLI docs, `.groc.json` config support
- Default output style
- Based on Solarized
- Searchable file and headline list
- Responsive layout

4 changes: 2 additions & 2 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,8 @@ Oh, and all the heavy lifting (splitting code and comments, parsing doc tags) is
- [x] Render doc tags (like jsdoc)
- [x] CLI docs, `.groc.json` config support
- [ ] Correctly parse relative roots
- [ ] Tests. Test for everything.
- [ ] Add another style.
- [x] Tests. Test for almost everything.
- [x] Add another style.
- [ ] Find a streaming code highlighter with hooks for comment segments
- [x] Parse files without extension

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "grock",
"version": "0.2.6",
"version": "0.3.0",
"description": "Convert commented code to awesome side-by-side documentation.",
"homepage": "http://killercup.github.io/grock/",
"main": "index.js",
Expand Down

0 comments on commit 51c8886

Please sign in to comment.