Pull in vuepress foir docs (as opposed to gitbook) (#742)

* Pull in latest @polkadot/dev, cleanup existing *.html * Cleanups (old gitbook interfaces) * Bump, WIP * Ready for testing * Update examples * Include source * Cleanup links * Adjust links * Add typedoc exclusions * Default classes from class files * Adjust imports * Adjust config * Re-add types split * Update links to substrate interfaces * Anchors for metadata * Adjust links * Restore HTML (to be deleted on CI) * Bump deps * Re-gen yarn.lock * Remove a in links * Adjust interfaces
2019-02-26 15:21:39 +01:00
parent 879fa28d0d
commit b313614935
104 changed files with 5510 additions and 7085 deletions
@@ -0,0 +1,48 @@
+module.exports = {
+  base: '/api/',
+  title: 'polkadot-js/api',
+  description: 'API libraries and interfaces for communicating with Polkadot and Substrate nodes',
+  markdown: {
+    lineNumbers: true
+  },
+  themeConfig: {
+    displayAllHeaders: true,
+    lastUpdated: 'Last Updated',
+    nav: [
+      { text: 'GitHub', link: 'https://github.com/polkadot-js/api' }
+    ],
+    sidebar: [
+      {
+        title: 'Examples (Promise API)',
+        path: '/examples/promise/',
+        collapsable: false,
+        sidebarDepth: 1,
+        children: [
+          ['examples/promise/01_simple_connect/', 'Simple connect'],
+          ['examples/promise/02_listen_to_blocks/', 'Listen to blocks'],
+          ['examples/promise/03_listen_to_balance_change/', 'Listen to balance change'],
+          ['examples/promise/04_unsubscribe/', 'Unsubscribe from listening'],
+          ['examples/promise/05_read_storage/', 'Read chain state'],
+          ['examples/promise/06_make_transfer/', 'Make a transfer'],
+          ['examples/promise/08_system_events/', 'Display system events'],
+          ['examples/promise/09_transfer_events/', 'Transaction with events'],
+          ['examples/promise/10_upgrade_chain/', 'Upgrade via sudo']
+        ]
+      },
+      {
+        title: 'Substrate interfaces',
+        collapsable: false,
+        sidebarDepth: 0,
+        children: [
+          ['/METHODS_RPC.md', 'Substrate RPC'],
+          ['/METHODS_STORAGE.md', 'State storage (defaults)'],
+          ['/METHODS_EXTRINSICS.md', 'Extrinsics (defaults)'],
+          ['/METHODS_EVENTS.md', 'System events (defaults)']
+        ]
+      },
+      ['/api/', '@polkadot/api'],
+      ['/types/', '@polkadot/types'],
+      '/CONTRIBUTING.md'
+    ]
+  }
+};
@@ -0,0 +1 @@
+$accentColor = #fd8824