documentation
documentation copied to clipboard
:book: documentation for modern JavaScript
## Input Code (Where `MyInput` is a file named `MyInput.jsx`) ```javascript // index.js export { Something } from 'MyInput'; ``` ## Output Error ``` { Error: Cannot find module '/Users/merrick/Developer/webflow/packages/systems/wfdl/MyInput'...
```typescript /** @internal */ export type AnyObj = { [key: string]: any }; ``` this will crash documentation ``` $ npx documentation readme src/** --readme-file=API.md --section=API --parse-extension ts --shallow --resolve...
Running from CLI, version 13.0.1 I use the following pattern to create a mix-in: ```js function createClass(superClass) { /** @class */ return class MyClass extends superClass { /** @memberof MyClass#...
Docs says that default HTML theme looks like: http://documentation.js.org/html-example/ (it is a pretty beautiful theme, great work)  When I used `npx documentation build *.js -f html -o docs/`, I...
A common pattern in modern js web development is to have several named utility modules with named and default exports. It would be ideal if `documentation.js` was smart enough to...
* What version of documentation.js are you using?: 13.0.1 * How are you running documentation.js (on the CLI, Node.js API, Grunt, other?): CLI When I use syntax that requires the...
I have `[email protected]` installed as a dev-dependency and am using it with an npm script configured as follows > `documentation readme -s Documentation src/**` Previously I was doing: > `documentation...
First of all thx for this great library, I've been using it with no problems for the past few months however since upgrading to the latest version I'm running into...
Project Restructure RFC ======================= Proposal to heavily reorganise the project structure to separate the concerns of different parts of the system. ****************************************************************** Introduction -------- I've been trying to find a...
Resolves #405