Commit Graph
7 Commits
Author SHA1 Message Date
Jaco Greeff 97b030100d Absolute logo url (#283) 2018-10-13 18:01:53 +02:00
Jaco Greeff 7bc8386806 AccountIndex encoding updates via util/keyring (#281)
* AccountIndex encoding updates via util/keyring

* Proper ss58 AccountIndex decoding from keyring

* Metadata allows both length and non-length prefixed

* Update doc logo size & relative URL
2018-10-13 17:33:40 +02:00
Luke Schoen 68f5ac27ed docs: Relates to #268. Add Polkadot white logo. Match styles to apps (#277)
* docs: Relates to #268. Add Polkadot white logo. Match styles to apps

* fix: Change logo url for plugin to production link

* fix: Remove Polkadot logo

* feat: Add Polkadot-js logo

* fix: Adjust styles for Polkadot-js logo
2018-10-13 16:38:29 +02:00
Luke Schoen bba764bd28 feat: Fixes #210. Add Mermaid.js Gitbook plugin. Generate API flow diagram (#211)
* feat: Add Mermaid.js Gitbook plugin. Generate API flow diagram

* fix: Remove HTTP from diagram. Change text to funnel user to WS
2018-10-10 13:16:36 +02:00
Luke Schoen d4990f8381 fix: Fixes #204. Adds coloured syntax highlighting to TypeDoc code examples (#207)
* fix: Fixes #204. Adds coloured syntax highlighting to TypeDoc code examples

* Add Gitbook plugin Sunlight Highlighter https://www.npmjs.com/package/gitbook-plugin-sunlight-highlighter

* Still requires use of <BR> HTML element to shift code onto a new line

* Example use of Sunlight Highlighter from their README `javascript+theme:gitbook+lineNumbers:true+lineNumberStart:100` (in this example it uses their gitbook theme with line numbers shown and line numbers starting from 100)

* Updated book.json to add the Sunlight Highlighter plugin, and explicitely configured it to use the gitbook theme by default

* Enable showing line numbers only on TypeDoc example code that is longer (i.e. 8 lines long)

* fix: Remove unnecessary inline config for no line numbers since is default

* fix: Remove use of line numbers so consistent with the rest
2018-10-05 17:34:32 +02:00
Jaco Greeff 4854379424 Gitbook rendering updates (#159)
* Add .nodoc for in-flux packages

* Start with clean-slate for re-generation

* Update with working (although manual) config
2018-09-19 16:14:37 +02:00
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