Version 0.13.0

srveit · May 8, 2015 · fa46c5c · fa46c5c
1 parent ec022b7
commit fa46c5c
Show file tree

Hide file tree

Showing 5 changed files with 63 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,31 @@
 # apiDoc Changelog
 
+
+#### 0.13.0
+
+**Important changes**:
+  * __Remove__ deprecated annotations [http://apidocjs.com/deprecated.html].
+  * __Replace__ markdown parser (markdown-it)[https://github.com/markdown-it/markdown-it].
+
+* CLI
+  * Add path to config file (with `-c`).
+  * Add multiple input locations (with `-i`).
+  * Remove markdown config parameters, for custom configurations view [MARKDOWN.md].
+  * Disable warning if packageJson.apidoc was defined.
+  * Add litcoffee and scala file extension.
+
+* Template
+  * Add `template.forceLanguage` in `apidoc.json` to set a fixed language file without auto-detect the browser language.
+  * Add word wrap for pure text examples.
+  * Add Brazilian, French, Polish and Russian translation files.
+
+* Parser
+  * Remove deprecated annotations [http://apidocjs.com/deprecated.html].
+  * Replace markdown parser with (markdown-it)[https://github.com/markdown-it/markdown-it].
+  * Add custom markdown parser support, view [MARKDOWN.md] for details.
+  * Add support for markdown in the type section. Example: `@apiParam {(CustomType)[http://...link-to-description.html]}`
+
+
 #### 0.12.2
 
 * CLI

diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
@@ -2,8 +2,29 @@
 
 Thanks to all people that help to make apiDoc better!
 
+* [Frank Lucht](https://github.com/Digigoodz)
+  * Add multiple input locations [#239](https://github.com/apidoc/apidoc/pull/239)
+
+* [赵健](https://github.com/karboom)
+  * Add word wrap for text examples [#241](https://github.com/apidoc/apidoc/pull/241)
+
+* [Tyler Clemens](https://github.com/tielur)
+  * Add a check to see if packageJson.apidoc was defined [#227](https://github.com/apidoc/apidoc/pull/227)
+
+* [Dmitry Krasyukov](https://github.com/p00h), [Alexej Yaroshevich](https://github.com/zxqfox), [Dmitry Kirilyuk](https://github.com/Jokero)
+  * Add Russian translation [#237](https://github.com/apidoc/apidoc/pull/237)
+
+* [Bruno Wego](https://github.com/brunowego)
+  * Add Brazilian translation [#249](https://github.com/apidoc/apidoc/pull/249)
+
+* [Rafał Zielonka](https://github.com/Bombaharris)
+  * Add Polish translation [#199](https://github.com/apidoc/apidoc/pull/199)
+
+* [Vincent Hérilier](https://github.com/vherilier)
+  * Add French translation [#191](https://github.com/apidoc/apidoc/pull/191)
+
 * [Hector Hernandez](https://github.com/alfadormx)
-  * Added support for markdown in the type section [#1](https://github.com/apidoc/apidoc-core/pull/15)
+  * Added support for markdown in the type section [#1](https://github.com/apidoc/apidoc-core/pull/1)
 
 * [Goonoo Kim](https://github.com/mctenshi)
   * Added litcoffee file extension [#5](https://github.com/apidoc/apidoc-core/pull/5)
@@ -15,13 +36,13 @@ Thanks to all people that help to make apiDoc better!
   * Unindent strings [#173](https://github.com/apidoc/apidoc/pull/173)
 
 * [大鼻子](https://github.com/wohugb)
-  * Add chinese translation (missing translations from google).
+  * Add chinese translation (missing translations from google)
 
 * [kimhoo](https://github.com/kimhoo)
-  * Add dutch translation (missing translations from google).
+  * Add dutch translation (missing translations from google)
 
 * [Danny Olson](https://github.com/dbolson)
-  * Add Clojure parser.
+  * Add Clojure parser
 
 * [Eugene Jo](https://github.com/iameugenejo)
   * Allowed options.packageInfo to overwrite default packageInfo [#177](https://github.com/apidoc/apidoc/pull/171))

diff --git a/MARKDOWN.md b/MARKDOWN.md
@@ -2,6 +2,9 @@
 
 By default apiDoc uses [markdown-it](https://github.com/markdown-it/markdown-it) Markdown Parser.
 
+If you need to modify the parser options or use an other markdown parser, create a .js file with a custom parser.
+
+Visit the markdown-it page for details, in particular if you want to use markdown plugins.
 
 
 ## Custom Parser

diff --git a/README.md b/README.md
@@ -50,7 +50,7 @@ More examples and best practice hints: [EXAMPLES.md](https://github.com/apidoc/a
 
 ## Supported programming languages
 
- * **C#, Go, Dart, Java, JavaScript, PHP** (all DocStyle capable languages):
+ * **C#, Go, Dart, Java, JavaScript, PHP, Scala** (all DocStyle capable languages):
 
    ```javascript
    /**
@@ -129,6 +129,12 @@ More examples and best practice hints: [EXAMPLES.md](https://github.com/apidoc/a
 * [Sublime Text plugin](https://github.com/DWand/ST3_apiDocAutocompletion)
 
 
+## Converter
+
+* [apidoc-swagger](https://github.com/fsbahman/apidoc-swagger)
+* [gulp-apidoc-swagger](https://github.com/fsbahman/gulp-apidoc-swagger)
+
+
 ## Help
 
 Please add [issues](https://github.com/apidoc/apidoc/issues) if you have a question or found a problem.

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "apidoc",
-  "version": "0.12.3",
+  "version": "0.13.0",
   "description": "RESTful web API Documentation Generator",
   "author": "Peter Rottmann <[email protected]>",
   "license": {
@@ -36,7 +36,7 @@
     "node": ">= 0.10.0"
   },
   "dependencies": {
-    "apidoc-core": "~0.3.2",
+    "apidoc-core": "~0.4.0",
     "fs-extra": "~0.18.2",
     "lodash": "~3.8.0",
     "markdown-it": "^4.2.1",