documentation

documentation copied to clipboard

I generally have trailing whitespace removed on save in all my files to prevent irritating diffs like this: ```diff -Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** +Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** ``` The difference is in the trailing...

c-vetter

Unfortunately, `documentation` escapes trailing backslashes that are meant for intentional line breaks. * What version of documentation.js are you using?: * version 9.3.1 * How are you running documentation.js (on...

c-vetter

Nested object property not showing in HTML output

1

**If you're reporting a bug, please include _input code_, _output documentation_, a description of what you expected to happen, and what happened instead.**   * What version of documentation.js...

thedark1337

CommonJS exporting a hash of functions not working

2

I have a few js files that group together some utility functions that are structured like this example: ``` js /** @module calculator */ /** * Adds two numbers *...

Eschon

Separated sections for each module

4

I am having some trouble setting up the documentationJS for my project. Right now I am using the command-line and I have been experimenting with: ``` documentation build -f md...

PolGuixe

Unexpected invisible token

8

## Error ```bash 132:1 warning unexpected token ``` Here's the line 132: ```js /** ``` I checked for encoding and the surrounding characters which are below: ```js }; /** *...

Berkmann18

Hello, I try to generate a nice documentation for my project in vueJS, and I discovered this repo which provides the integration for .vue file. I'm able to generate a...

vincent-herreros

My two cents: Given that passing a `paths` option when generating Markdown format (haven't tried that with HTML output) will allow Documentation.js to automagically link said definition to the respective...

ffflabs

How to replace ```javascript with ```js static in code blocks ? Is there a way to change the highlight language?

6

Hi all, I have just tested documentjs and it work great. The author of react-styleguidist recommended documentationjs after someone asked a question https://github.com/styleguidist/react-styleguidist/issues/445#issuecomment-302117671 I have issue with the generated markdown...

kopax

can the generated `new Foo()` code from class / functions be disabled/overrided by a @example?

7

``` /** */ class Foo {..} ``` will generate doc with a code block: ``` new Foo() ``` Similarly, functions will generate an automatic block. I have 2 usecases where...

gre