diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 981518ac..6feb3534 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -1,16 +1,26 @@ module.exports = { base: '/ui/', title: 'polkadot-js/ui', - description: 'UI libraries and utilities in-use accross @polkadot projects', + description: 'UI utilities, libraries and React components in use accross @polkadot projects', markdown: { lineNumbers: true }, themeConfig: { displayAllHeaders: true, - lastUpdated: 'Last Updated', nav: [ + { text: 'Polkadot/Substrate Apps', link: 'https://polkadot.js.org/apps/' }, + { text: 'Project family', link: 'https://polkadot.js.org/' }, + { + text: 'Documentation', + items: [ + { text: 'API Reference', link: 'https://polkadot.js.org/api/' }, + { text: 'Utility Reference', link: 'https://polkadot.js.org/common/' }, + { text: 'UI Libs Reference (this)', link: 'https://polkadot.js.org/ui/' }, + ] + }, { text: 'GitHub', link: 'https://github.com/polkadot-js/ui' } ], + search: false, sidebar: [ ['/ui-identicon/', '@polkadot/ui-identicon'], ['/ui-keyring/', '@polkadot/ui-keyring'], diff --git a/docs/.vuepress/styles/palette.styl b/docs/.vuepress/styles/palette.styl index 37ea71e5..cd866cf8 100644 --- a/docs/.vuepress/styles/palette.styl +++ b/docs/.vuepress/styles/palette.styl @@ -1 +1,9 @@ $accentColor = #fd8824 +$textColor = #2c3e50 + +.home .hero .description, +.home .feature h2, +.home .feature p { + color: $textColor + opacity: 0.75 +} diff --git a/docs/README.md b/docs/README.md index cf579a7b..9093084d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,37 @@ -# Polkadot Javascript UI libraries +--- +home: true +heroText: +tagline: +# Bringing JavaScript to the Polkadot world. +# actionText: Repository Overview +# actionLink: /REPOS.md +features: +- title: Identicon + details: A flexible identity icon generator supporting a number of display styles based on theme. +- title: Keyring + details: An extension to the base keyring that allows for additions such as browser storage. +- title: Utilities + details: Utilities for formatting and working with settings inside any browser-based application. -This is a collection of UI (React) libraries, utlities and classes that allows for easier use of the Polkadot JS infrstaructure inside your apps. +footer: Apache-2 Licensed | Copyright © 2017-2019 polkadot-js authors and contributors +--- + +## Welcome + +This is a collection of UI (React) libraries, utlities and classes that allows for easier use of the Polkadot JS infrastructure inside your apps. + +::: tip Examples +In a rush and just want examples? [Jump right in](ui-identicon/README.md) and get a handle the libraries in your projects. +::: + +## Available packages + +This repository split up into a number of internal packages, namely - + +- [identicon](ui-identicon/README.md) Display of identity icons based on theme +- [keyring](ui-keyring/README.md) A keyring with browser-specific extensions +- [settings](ui-settings/README.md) Setting management and defaults +- [util](ui-util/README.md) UI-specific utility functions ## The Polkadot Project diff --git a/packages/ui-identicon/package.json b/packages/ui-identicon/package.json index 6b93be03..1536684a 100644 --- a/packages/ui-identicon/package.json +++ b/packages/ui-identicon/package.json @@ -23,8 +23,8 @@ "react": "*" }, "devDependencies": { - "@polkadot/keyring": "^0.34.35", - "@polkadot/util-crypto": "^0.34.35", + "@polkadot/keyring": "^0.34.36", + "@polkadot/util-crypto": "^0.34.36", "xmlserializer": "^0.6.1" } } diff --git a/packages/ui-keyring/package.json b/packages/ui-keyring/package.json index da9f6394..b8b306b9 100644 --- a/packages/ui-keyring/package.json +++ b/packages/ui-keyring/package.json @@ -16,9 +16,9 @@ "store": "^2.0.12" }, "devDependencies": { - "@polkadot/keyring": "^0.34.35", - "@polkadot/types": "^0.45.19", - "@polkadot/util": "^0.34.35" + "@polkadot/keyring": "^0.34.36", + "@polkadot/types": "^0.45.21", + "@polkadot/util": "^0.34.36" }, "peerDependencies": { "@polkadot/keyring": "*", diff --git a/packages/ui-util/package.json b/packages/ui-util/package.json index 0781a6d1..17380ab4 100644 --- a/packages/ui-util/package.json +++ b/packages/ui-util/package.json @@ -12,7 +12,7 @@ "@babel/runtime": "^7.3.4" }, "devDependencies": { - "@polkadot/types": "^0.45.19" + "@polkadot/types": "^0.45.21" }, "peerDependencies": { "@polkadot/types": "*" diff --git a/yarn.lock b/yarn.lock index bc094d0c..a802fe71 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1533,14 +1533,14 @@ typescript "^3.3.3333" vuepress "^1.0.0-alpha.40" -"@polkadot/keyring@^0.34.35": - version "0.34.35" - resolved "https://registry.yarnpkg.com/@polkadot/keyring/-/keyring-0.34.35.tgz#77d09b2ab22e07dd544574451e48e16956a2cda1" - integrity sha512-E85kIZDY+SLzNgwQ5dWS8GOMaX6djq1PKVj+v5B2Oii9plNJRh7vXOf/127IWMcSC3gNG6Gen3SxquM5/vkbFw== +"@polkadot/keyring@^0.34.36": + version "0.34.36" + resolved "https://registry.yarnpkg.com/@polkadot/keyring/-/keyring-0.34.36.tgz#cc88802a6128dee8850874226e5bdef2ca22952f" + integrity sha512-AWf4mIWokVLInEOfEBOZ8MnPbMs04V22kjIJ3tcYuantUUc947dW39lKKgSY8R3qF37Y5VU/ILmBzOBy6cvLCg== dependencies: "@babel/runtime" "^7.3.4" - "@polkadot/util" "^0.34.35" - "@polkadot/util-crypto" "^0.34.35" + "@polkadot/util" "^0.34.36" + "@polkadot/util-crypto" "^0.34.36" "@types/bs58" "^4.0.0" bs58 "^4.0.1" @@ -1554,24 +1554,24 @@ resolved "https://registry.yarnpkg.com/@polkadot/ts/-/ts-0.1.54.tgz#cac6a12809f886fb7698bfbf3ffb27b793f7745d" integrity sha512-wYiJZ62v0IyG7jO6nQ7XsxHiYJH1i0x3BuHPiV/LiAq4QSX0LVv0q3SbN7hwrEDb4kmHtHkKpF9iXV8fKLFH2w== -"@polkadot/types@^0.45.19": - version "0.45.19" - resolved "https://registry.yarnpkg.com/@polkadot/types/-/types-0.45.19.tgz#2b1d4eab5e61a412bcedabdfde912f764b8ca87d" - integrity sha512-Hwj9rStHHAmcQ2rYhxBBNXy1VRsrjV2qAWGjRzvPIMxGxuzwwdbOVHGNmFx9OYa+urKrwA7yScK+TBUD477J8g== +"@polkadot/types@^0.45.21": + version "0.45.21" + resolved "https://registry.yarnpkg.com/@polkadot/types/-/types-0.45.21.tgz#5ded5d141d84dcca1d93592701cabcd72de88ffa" + integrity sha512-H6GD3J8HOtq2hpteTKqgelfhVPkJYxSHQ05gtCkbSCRLeeYKBDJyHsh6dByiU0g2Pspk44+LX4u+zxCbOXMeOA== dependencies: "@babel/runtime" "^7.3.4" - "@polkadot/keyring" "^0.34.35" - "@polkadot/util" "^0.34.35" + "@polkadot/keyring" "^0.34.36" + "@polkadot/util" "^0.34.36" core-js "^2.6.5" -"@polkadot/util-crypto@^0.34.35": - version "0.34.35" - resolved "https://registry.yarnpkg.com/@polkadot/util-crypto/-/util-crypto-0.34.35.tgz#82b04d2e5903ca315bda0f22438b026162963c70" - integrity sha512-n6zzswFnsG62cZMAliV/VIZUDiW0gKjCrjMaiT9ozzZ9TUjUDNLbFtJ++15vp3s0cl4mnluhGXZKuWRjqhQIHw== +"@polkadot/util-crypto@^0.34.36": + version "0.34.36" + resolved "https://registry.yarnpkg.com/@polkadot/util-crypto/-/util-crypto-0.34.36.tgz#d58d8ef3d1501cc6dd87f11a092e3c27791c5b67" + integrity sha512-DMUhMhIPDmduV1Rw+aVP1zP7SIn3C3utRcleMriSWlqWZJGA8D5xMQUW8samOLee+Ev7pPO5QrnCQOmFY6+tpQ== dependencies: "@babel/runtime" "^7.3.4" "@polkadot/schnorrkel-js" "^0.1.2-2" - "@polkadot/util" "^0.34.35" + "@polkadot/util" "^0.34.36" "@types/bip39" "^2.4.2" "@types/pbkdf2" "^3.0.0" "@types/secp256k1" "^3.5.0" @@ -1584,10 +1584,10 @@ tweetnacl "^1.0.1" xxhashjs "^0.2.2" -"@polkadot/util@^0.34.35": - version "0.34.35" - resolved "https://registry.yarnpkg.com/@polkadot/util/-/util-0.34.35.tgz#e395ac8faaae0f8b57419e0e775c0d6ef1f9f3ae" - integrity sha512-zbU8EPuxg4Ig7Ugyan6ZZM92SShxKSLAc0aoY8bGvufDkZAtl2wQqBEpip/JjJ6DIHDHrx7lEWeZTdQ67Ad8Bg== +"@polkadot/util@^0.34.36": + version "0.34.36" + resolved "https://registry.yarnpkg.com/@polkadot/util/-/util-0.34.36.tgz#eeb699202d9e3dfb7e64277ef5179334f1d97737" + integrity sha512-BTDvWeieW5hZABK54kt37e+f8GfmnfwGdNaKI1AKZA4p7Ms5iRCKMVRTSx3p69zLT10KChOlhUPGgdr/AlFFtg== dependencies: "@babel/runtime" "^7.3.4" "@types/bn.js" "^4.11.4"