Files
api/typedoc.js
T
Chevdor 0981a30d84 Add documentation and examples (#145)
* Add documentation

* Justification u8a decoding and json encoding (#146)

* Decode Justifications

* Json encoding for justifications

* Bump deps

* Allow extrinsic length encoding to operate on u8a[] (#148)

* Fix config and move generated doc to a subfolder

* Cleanup extrinsic encoding (#150)

* Cleanup extrinsic encoding

* Removed now-defunct type

* Add uncheckedLength encoding

* Add examples

* Ignore package-lock since we use yarn

* Cleanup examples

* Add gitbook config and some base files for the doc

* Do not make full doc mandatory for now

* Add contributing guide, polish doc and samples

* Update the deps of all samples and add yarn scripts
Fix and regenerate the doc

* Fix Contributing guide
2018-09-15 09:11:56 +02:00

20 lines
481 B
JavaScript

module.exports = {
name: 'Polkadot JS API',
mode: 'file',
exclude: ['test', '**/*spec.ts'],
excludeExternals: true,
excludeNotExported: true,
excludePrivate: true,
hideGenerator: true,
includes: './docs/guides',
includeDeclarations: true,
out: 'docs/api',
module: 'commonjs',
stripInternal: 'true',
theme: 'markdown',
ignoreCompilerErrors: true,
moduleResolution: 'node',
suppressExcessPropertyErrors: true,
suppressImplicitAnyIndexErrors: true
}