diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index fda5e3846..e1c77cf28 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -1,15 +1,26 @@ module.exports = { base: '/common/', title: 'polkadot-js/common', - description: 'Utilities and libraries in-use accross @polkadot projects', + description: 'Common utilities and libraries that are in use accross all @polkadot projects', markdown: { lineNumbers: true }, themeConfig: { displayAllHeaders: true, nav: [ - { text: 'GitHub', link: 'https://github.com/polkadot-js/common' } + { 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 (this)', link: 'https://polkadot.js.org/common/' }, + { text: 'UI Libs Reference', link: 'https://polkadot.js.org/ui/' }, + ] + }, + { text: 'GitHub Repo', link: 'https://github.com/polkadot-js/common' } ], + search: false, sidebar: [ { title: 'Examples (keyring)', diff --git a/docs/.vuepress/styles/palette.styl b/docs/.vuepress/styles/palette.styl index 37ea71e5e..cd866cf86 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 c8a6f8166..f81b6081e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,7 +1,31 @@ -# Polkadot Javascript Common +--- +home: true +heroText: +tagline: +# Bringing JavaScript to the Polkadot world. +# actionText: Repository Overview +# actionLink: /REPOS.md +features: +- title: Keyring + details: Manage user keys allowing for signing, encryption and decryption. +- title: Utilities + details: Various user utilities to work with data and perform check on it. +- title: Crypto + details: A thin and easy-to-use wrapper around cryptographic and hashing libraries. + +footer: Apache-2 Licensed | Copyright © 2017-2019 polkadot-js authors and contributors +--- + +## Welcome Various useful utility functions that are used across all projects in the [@polkadot](https://polkadot.js.org) namespace. It provides utility functions with additional safety checks, allowing not only for consistent coding, but also reducing the general boilerplate. +::: tip Examples +In a rush and just want examples? [Jump right in](/examples/keyring/) and get a handle on using the various components in your projects. +::: + +## Available packages + It is split up into a number of internal packages, namely utilities - - [keyring](keyring/README.md) Keyring management