Skip to content

Commit

Permalink
updated docs for compatibility with github-pages
Browse files Browse the repository at this point in the history
  • Loading branch information
bee344 committed Feb 29, 2024
1 parent bcb2928 commit 4a6f20e
Show file tree
Hide file tree
Showing 443 changed files with 3,702 additions and 7,444 deletions.
57 changes: 33 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,23 @@
# txwrapper-core

Tools for FRAME chain builders to publish chain specific offline transaction generation libraries.

## Table of contents

- [Overview](#overview)
- [Modules](#modules)
- [End user examples](packages/txwrapper-examples/README.md)
- [Chain builder guide](CHAIN_BUILDER.md)
- [Develop, contribute, and maintain](#develop-contribute-and-maintain)
<br /><br />

<div align="center">
<h1 align="center">txwrapper-core</h1>
<h4 align="center"> Tools for FRAME chain builders to publish chain specific offline transaction generation libraries.
</h4>
<p align="center">
<a href="https://www.npmjs.com/package/@substrate/txwrapper-core">
<img alt="npm" src="https://img.shields.io/npm/v/@substrate/txwrapper-core" />
</a>
<a href="https://github.com/paritytech/txwrapper-core/actions">
<img alt="Github Actions" src="https://github.com/paritytech/txwrapper-core/workflows/pr/badge.svg" />
</a>
<a href="https://github.com/paritytech/txwrapper-core/blob/master/LICENSE">
<img alt="GPL-3.0-or-later" src="https://img.shields.io/npm/l/@substrate/txwrapper-core" />
</a>
</p>
</div>

<br /><br />

## Overview

Expand All @@ -20,31 +29,31 @@ For example, those looking to construct a transaction offline on Polkadot would

#### Published

- [@substrate/txwrapper-polkadot](/packages/txwrapper-polkadot/README.md) Helper functions for offline transaction generation for polkadot relay and system chains; specifically the following chains: Polkadot, Kusama, Rococo, Westend, Asset Hub Polkadot and Asset Hub Kusama.
- [@substrate/txwrapper-core](/packages/txwrapper-core/README.md) The essentials for creating a chain specific txwrapper lib.
- [@substrate/txwrapper-registry](/packages/txwrapper-registry/README.md) Registry creation support, catering to chains with types in [@polkadot/apps-config](https://github.com/polkadot-js/apps/tree/master/packages/apps-config/README.md).
- [@substrate/txwrapper-substrate](/packages/txwrapper-substrate/README.md) Selected dispatchables of Substrate pallets, to be re-exported by txwrappers (e.g. @substrate/txwrapper-polkadot).
- [@substrate/txwrapper-orml](/packages/txwrapper-orml/README.md) Selected dispatchables of ORML pallets, to be re-exported by txwrappers (e.g. txwrapper-acala).
- [@substrate/txwrapper-polkadot](modules/txwrapper_polkadot_src.html) Helper functions for offline transaction generation for polkadot relay and system chains; specifically the following chains: Polkadot, Kusama, Rococo, Westend, Asset Hub Polkadot and Asset Hub Kusama.
- [@substrate/txwrapper-core](modules/txwrapper_core_src.html) The essentials for creating a chain specific txwrapper lib.
- [@substrate/txwrapper-registry](modules/txwrapper_registry_src.html) Registry creation support, catering to chains with types in [@polkadot/apps-config](https://github.com/polkadot-js/apps/tree/master/packages/apps-config/README.md).
- [@substrate/txwrapper-substrate](modules/txwrapper_substrate_src.html) Selected dispatchables of Substrate pallets, to be re-exported by txwrappers (e.g. @substrate/txwrapper-polkadot).
- [@substrate/txwrapper-orml](modules/txwrapper_orml_src.html) Selected dispatchables of ORML pallets, to be re-exported by txwrappers (e.g. txwrapper-acala).
- [@substrate/txwrapper-dev](https://github.com/paritytech/txwrapper-core/tree/main/packages/txwrapper-dev) Exported development helpers such as registries and metadata.

#### Non-published

- [@substrate/txwrapper-dev](/packages/txwrapper-dev/README.md) Exported development helpers such as registries and metadata.
- [@substrate/txwrapper-example](/packages/txwrapper-examples/README.md) Usage examples including how to construct, sign, and decode an extrinsic with @substrate/txwrapper-polkadot.
- [@substrate/txwrapper-template](/packages/txwrapper-template/README.md) Template package for chain builders.
- [@substrate/txwrapper-example](https://github.com/paritytech/txwrapper-core/tree/main/packages/txwrapper-examples) Usage examples including how to construct, sign, and decode an extrinsic with @substrate/txwrapper-polkadot.
- [@substrate/txwrapper-template](https://github.com/paritytech/txwrapper-core/tree/main/packages/txwrapper-template) Template package for chain builders.

## Modules

- [txwrapper-core/src](docs/modules/txwrapper_core_src.md)
- [txwrapper-polkadot/src](docs/modules/txwrapper_polkadot_src.md)
- [txwrapper-substrate/src](docs/modules/txwrapper_substrate_src.md)
- [txwrapper-core/src](modules/txwrapper_core_src.html)
- [txwrapper-polkadot/src](modules/txwrapper_polkadot_src.html)
- [txwrapper-substrate/src](modules/txwrapper_substrate_src.html)

## End user examples

[Click here for examples on how to use txwrappers for constructing, signing, and decoding transactions.](packages/txwrapper-examples/README.md)
[Click here for examples on how to use txwrappers for constructing, signing, and decoding transactions.](https://github.com/paritytech/txwrapper-core/tree/main/packages/txwrapper-examples)

## Chain builder guide

[Click here to find our guide for chain builders.](CHAIN_BUILDER.md) The guide explains how to make a chain specific txwrapper.
[Click here to find our guide for chain builders.](https://github.com/paritytech/txwrapper-core/blob/main/CHAIN_BUILDER.md). The guide explains how to make a chain specific txwrapper.

## Develop, contribute, and maintain

Expand Down
164 changes: 0 additions & 164 deletions docs/README.md

This file was deleted.

85 changes: 85 additions & 0 deletions docs/assets/highlight.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
:root {
--light-hl-0: #795E26;
--dark-hl-0: #DCDCAA;
--light-hl-1: #000000;
--dark-hl-1: #D4D4D4;
--light-hl-2: #A31515;
--dark-hl-2: #CE9178;
--light-hl-3: #008000;
--dark-hl-3: #6A9955;
--light-hl-4: #0000FF;
--dark-hl-4: #569CD6;
--light-hl-5: #0070C1;
--dark-hl-5: #4FC1FF;
--light-hl-6: #001080;
--dark-hl-6: #9CDCFE;
--light-hl-7: #098658;
--dark-hl-7: #B5CEA8;
--light-hl-8: #AF00DB;
--dark-hl-8: #C586C0;
--light-code-background: #FFFFFF;
--dark-code-background: #1E1E1E;
}

@media (prefers-color-scheme: light) { :root {
--hl-0: var(--light-hl-0);
--hl-1: var(--light-hl-1);
--hl-2: var(--light-hl-2);
--hl-3: var(--light-hl-3);
--hl-4: var(--light-hl-4);
--hl-5: var(--light-hl-5);
--hl-6: var(--light-hl-6);
--hl-7: var(--light-hl-7);
--hl-8: var(--light-hl-8);
--code-background: var(--light-code-background);
} }

@media (prefers-color-scheme: dark) { :root {
--hl-0: var(--dark-hl-0);
--hl-1: var(--dark-hl-1);
--hl-2: var(--dark-hl-2);
--hl-3: var(--dark-hl-3);
--hl-4: var(--dark-hl-4);
--hl-5: var(--dark-hl-5);
--hl-6: var(--dark-hl-6);
--hl-7: var(--dark-hl-7);
--hl-8: var(--dark-hl-8);
--code-background: var(--dark-code-background);
} }

:root[data-theme='light'] {
--hl-0: var(--light-hl-0);
--hl-1: var(--light-hl-1);
--hl-2: var(--light-hl-2);
--hl-3: var(--light-hl-3);
--hl-4: var(--light-hl-4);
--hl-5: var(--light-hl-5);
--hl-6: var(--light-hl-6);
--hl-7: var(--light-hl-7);
--hl-8: var(--light-hl-8);
--code-background: var(--light-code-background);
}

:root[data-theme='dark'] {
--hl-0: var(--dark-hl-0);
--hl-1: var(--dark-hl-1);
--hl-2: var(--dark-hl-2);
--hl-3: var(--dark-hl-3);
--hl-4: var(--dark-hl-4);
--hl-5: var(--dark-hl-5);
--hl-6: var(--dark-hl-6);
--hl-7: var(--dark-hl-7);
--hl-8: var(--dark-hl-8);
--code-background: var(--dark-code-background);
}

.hl-0 { color: var(--hl-0); }
.hl-1 { color: var(--hl-1); }
.hl-2 { color: var(--hl-2); }
.hl-3 { color: var(--hl-3); }
.hl-4 { color: var(--hl-4); }
.hl-5 { color: var(--hl-5); }
.hl-6 { color: var(--hl-6); }
.hl-7 { color: var(--hl-7); }
.hl-8 { color: var(--hl-8); }
pre, code { background: var(--code-background); }
59 changes: 59 additions & 0 deletions docs/assets/main.js

Large diffs are not rendered by default.

Loading

0 comments on commit 4a6f20e

Please sign in to comment.