documentation

documentation copied to clipboard

**If you're reporting a bug, please include _input code_, _output documentation_, a description of what you expected to happen, and what happened instead.** [link text]{@link url} is not working since...

jeonghee27

New release (without ansi-html)

2

We use `13.2.5` That version depends on `ansi-html` `^0.0.7` Which has this security issue: https://github.com/advisories/GHSA-whgm-jr23-g3j9 The master branch no longer has this dependency but has not been released for over...

francisdb

getting babel related issues when generating documentation

5

Getting babel related issues when running: `documentation build './packages/*' -f html -o docs --document-exported --babel=./babel.config.js` I am not sure what should babel.config.js have to support the error that generating! I...

lfaz

* **Input code:** [`KaKi87/puppeteer-helpers/mod.js`](https://git.kaki87.net/KaKi87/puppeteer-helpers/src/branch/master/mod.js) * **Output documentation:** [`KaKi87/puppeteer-helpers/DOCUMENTATION.md`](https://git.kaki87.net/KaKi87/puppeteer-helpers/src/branch/master/DOCUMENTATION.md) * **Expected:** methods returned by [`page.js`](https://git.kaki87.net/KaKi87/puppeteer-helpers/src/branch/master/src/page.js) & [`userPreferences.js`](https://git.kaki87.net/KaKi87/puppeteer-helpers/src/branch/master/src/userPreferences.js)'s exported functions are correctly indented like methods returned by [`browser.js`](https://git.kaki87.net/KaKi87/puppeteer-helpers/src/branch/master/src/browser.js)'s exported function * **Actual:**...

KaKi87

Plugin framework for documentation

4

Suggestion: Implement a plugin framework allowing to easily extend `documentation` I have two distinct use cases for this: * Being able to add a parser (for example C++) and to...

mmomtchev

Fixes #1272. Fixes #1258. I was gonna add a test based on the existing `--document-exported` case, but unfortunately it's skipped: https://github.com/documentationjs/documentation/blob/a31e73219c553c1a1e6c49e9094293f2c2c4608f/__tests__/bin.js#L371-L378

buschtoens

TypeScript imports cannot be resolved

10

### Input #### CLI command ```sh yarn documentation build --document-exported src/index.ts --format md --github ``` #### `src/index.ts` ```ts export { default as useDeviceMotion } from './useDeviceMotion'; // Missing '.ts' extension...

kripod

It's not clear how to run this on TypeScript files (f.e. it produces empty docs)

25

Gleening from some examples in the issues, I'm running ```sh documentation serve ./src/index.js --parse-extension ts ``` and `src/index.js` has an `export * from './components'` where the `./components` folder has `index.ts`,...

trusktr

Error: Cannot find module 'documentation'

5

I am trying to use the API. I installed documention.js (13.2.5) using npm (6.14.16) and it is working fine from the command line. However this does not generate a module...

bobbrowning

In a project that I am converting to documentation I have: * `gdal.Group.arrays` property in `gdal.Group` class * `gdal.GroupArrays` class They both end up having a div id of `gdalgrouparrays`...

mmomtchev