Skip to content

Commit

Permalink
1.5.2
Browse files Browse the repository at this point in the history
  • Loading branch information
onury committed Dec 8, 2017
1 parent 19a4457 commit 40b9398
Showing 1 changed file with 26 additions and 2 deletions.
28 changes: 26 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,32 @@
### v1.5.2 (2017-12-09)

- <p><b>Docma Web Core</b>:</p>

+ **Fixed** `$ is not a function` error on Windows. PR [#23](https://github.com/onury/docma/pull/23) by [@warpdesign](https://github.com/warpdesign).
+ **Fixed** some typos in documentation. PRs [#13](https://github.com/onury/docma/pull/13), [#17](https://github.com/onury/docma/pull/17).
_**Note**: For this release, some dependencies (such as `jsdoc-x`, `jsdom`) are NOT updated on purpose 'cause they introduce breaking changes. In **v2** (WIP, to be released) these will be updated and many things will be improved._

> _**Note**: For this release, some dependencies (such as `jsdoc-x`, `jsdom`) are NOT updated on purpose 'cause they introduce breaking changes. In **v2** (WIP, to be released) these will be updated and many things will be improved._
### v1.5.1 (2017-03-11)

- <p><b>Docma Web Core</b>:</p>

+ **Fixed** `slice` error for non-string default value.

### v1.5.0 (2017-03-10)

- <p><b>Docma</b> (Builder):</p>

+ **Added** `config.jsdoc.ignored:Boolean` option which specifies whether to include documentation symbols marked with `@ignore` tag.

- <p><b>Docma Web Core</b>:</p>

+ **Fixed** an issue where empty lines would be stripped out from `@example` content.
+ **Improved** auto-indention for code in comments.
+ **Improved** `$val` filter.

- <p><b>Default Template</b>:</p>

+ **Improved** sidebar design.
+ **Added** template option `outline`, which determines the outline style of the sidebar symbols list. (`"flat"` or `"tree"`). See [documentation](https://onury.github.io/docma/?content=default-template) and [this example](https://onury.github.io/accesscontrol/?api=ac) for `outline` set to `"tree"`.
+ **Added** template option `symbolMeta` which specifies whether to add meta information at the end of each symbol documentation such as code file name and line number. Default is `false`.
Expand All @@ -32,55 +39,66 @@ _**Note**: For this release, some dependencies (such as `jsdoc-x`, `jsdom`) are
### v1.4.7 (2017-03-09)

- <p><b>Docma</b> (Builder):</p>

+ **Fixed** an issue where build config `config.jsdoc.includePattern` would not be respected when filtering files.
+ **Fixed** an issue where sorting would change when `config.jsdoc.hierarchy` option is enabled.

### v1.4.5 (2017-03-05)

- <p><b>Docma</b> (Builder):</p>

+ **Added** build config options: `config.jsdoc.allowUnknownTags`, `config.jsdoc.dictionaries`, `config.jsdoc.includePattern`, `config.jsdoc.excludePattern` (`jsdoc-x` feature).
+ **Added** [JSDoc plugin](http://usejsdoc.org/about-plugins.html) support via the new `config.jsdoc.plugins` option (`jsdoc-x` feature).

### v1.4.0 (2017-02-13)

- <p><b>Docma</b> (Builder):</p>

+ **Fixed** incorrect routing when routing method is set to `"path"`.
+ If `config.app.entrance` is not set in build configuration, it now defaults to `"api"`.
+ If `config.app.server` is not set in build configuration, it now defaults to `"static"`. (`"static"` is similar to `"github"` which generates static HTML files.)

- <p><b>Docma CLI</b>:</p>

+ Respecting debug option in config file. If no debug options are set in the command-line arguments (such as `--debug`, `--quite`, `--nomin`, `--jd-out`, `--verbose`, `--web-logs`); the bitwise debug value from the config file is used, if set.

- <p><b>Docma Web Core</b>:</p>

+ **Fixed** `.split()` error for `null` (404) routes.
+ **Updated** web dependencies to latest versions.

- <p><b>Default Template</b>:</p>

+ **Fixed** a style issue where sidebar would not scroll all the way to the bottom in Firefox. Fixes [issue #8](https://github.com/onury/docma/issues/8).
+ If `config.template.title` is omitted, `config.app.title` is used. (Defaults to `"Documentation"` if not set).

### v1.3.0 (2016-11-23)

- <p><b>Docma</b> (Builder):</p>

+ **Added** case-sensitive routing option. `config.app.routing` accepts either a `String` (`"query"` or `"path"` as before) or now, an `Object`. e.g. `{ type: "query", caseSensitive: true }`. This also fixes [issue #3](https://github.com/onury/docma/issues/3).
+ **Updated** dependencies to their latest versions.
+ Minor code revisions.

- <p><b>Docma Web Core</b>:</p>

+ **Extended** support for parsing back-ticks in documentation. Added triple back-tick support for multiline code blocks (<code>&#x60;&#x60;&#x60;</code>).
+ **Improved** `docma.utils.normalizeTabs()` method. Deep indents in JSDoc comments/descriptions are also normalized.
+ **Improved** support for `<pre></pre>` tags within JSDoc descriptions.

- <p><b>Default Template</b>:</p>

+ **Fixed** an issue where symbols with return type parameters (such as `Promise<Array>`) would not be escaped and parsed properly. Fixes [issue #4](https://github.com/onury/docma/issues/4).
+ **Fixed** an issue where boolean symbol parameters' default values would not be parsed properly. Fixes [issue #5](https://github.com/onury/docma/issues/5).

### v1.2.0 (2016-10-31)

- <p><b>Docma CLI</b>:</p>

+ **Added** CLI (command-line interface). Supports `config`, `src`, `dest` and all `debug` options.

- <p><b>Default Template</b>:</p>

+ **Updated** (one-dark) highlighting styles.

### v1.1.1 (2016-08-13)
Expand All @@ -90,11 +108,13 @@ _**Note**: For this release, some dependencies (such as `jsdoc-x`, `jsdom`) are
### v1.1.0 (2016-08-12)

- <p><b>Docma</b> (Builder):</p>

+ **Fixed** an issue where constructors would still show up in the documentation even though `@private` is set. Fixed by `jsdoc-x`.
+ **Updated** dependencies to their latest versions.
+ Minor revisions.

- <p><b>Default Template</b>:</p>

+ **Fixed** sidebar header/search position when sidebar is collapsed.
+ An access badge is shown next to symbol name, if symbol has `private` or `protected` access.
+ Clean up.
Expand All @@ -112,6 +132,7 @@ _**Note**: For this release, some dependencies (such as `jsdoc-x`, `jsdom`) are
### v1.0.0 (2016-06-11)

- <p><b>Docma</b> (Builder):</p>

+ **Added** ability to convert markdown files to HTML. See documentation.
+ **Added** `.markdown:Object` build configuration options. (Same as `marked` module options).
+ **Added** `.markdown.tasks:Boolean` option for parsing GitHub-like markdown tasks.
Expand All @@ -128,6 +149,7 @@ _**Note**: For this release, some dependencies (such as `jsdoc-x`, `jsdom`) are
+ **Added** negated glob support (that excludes the paths) for the `src` build option.

- <p><b>Docma Web Core</b>:</p>

+ **Added** client-side routing support for the SPA with paths (e.g. `/api`) or query-strings (e.g. `?content=api`). Configured via `.app.routing:String` option. Set to `"path"` or `"query"`. Uses page.js internally.
+ **Implemented** `EventEmitter`.
+ **BREAKING CHANGE**: Dropped `docma.ready()` method. Use `docma.on('ready', listener)` that's only triggered once on every page load or `docma.on('render', listener)` triggered when each content is rendered. Also see `docma.on('route', listener)` triggered when SPA route is changed.
Expand All @@ -139,6 +161,7 @@ _**Note**: For this release, some dependencies (such as `jsdoc-x`, `jsdom`) are
+ **Revision**: If `debug >= 3`, web app will also output logs.

- <p><b>Default Template</b>:</p>

+ **Improved** layout for HTML files converted from markdown.
+ **Fixed** documentation of `@property` JSDoc tags.
+ **Updated** default template structure.
Expand All @@ -152,6 +175,7 @@ _**Note**: For this release, some dependencies (such as `jsdoc-x`, `jsdom`) are
+ **Improved** various API documentation styles.

- <p>Other:</p>

+ **(Dev)** Manage web-component dependency packages via Bower.
+ **Updated** project structure.
+ Various minor revisions and clean-up.
Expand Down

0 comments on commit 40b9398

Please sign in to comment.