generated from Consensys/doc.ethsigner
-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
17a3a99
commit 04365f7
Showing
1 changed file
with
18 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,26 @@ | ||
# Web3Signer documentation | ||
|
||
Latest: [![Documentation Status](https://readthedocs.com/projects/pegasys-web3signer/badge/?version=latest)](https://docs.web3signer.consensys.net/en/latest/?badge=latest) | ||
Stable: [![Documentation Status](https://readthedocs.com/projects/pegasys-web3signer/badge/?version=stable)](https://docs.web3signer.consensys.net/en/stable/?badge=stable) | ||
[Web3Signer] is a transaction signing application to be used with a web3 provider. The software sources are hosted in the [Web3Signer] repository. | ||
|
||
[Web3Signer] is a transaction signing application to be used with a web3 provider. | ||
This documentation repo is built using [Docusaurus 2](https://docusaurus.io/). | ||
|
||
The software sources are hosted in [Web3Signer] repository. | ||
See [more](https://docs-template.consensys.net/) information about using Docusaurus quickly. | ||
|
||
This repository only contains the sources for [Web3Signer documentation website hosted by ReadTheDocs.com]. | ||
### Contributing & Local Development | ||
|
||
This repository uses a Git submodule. Please refer to the [common tools wiki] for explanation about | ||
how to build and contribute to this documentation. | ||
$ npm install | ||
$ npm run prepare | ||
$ npm start | ||
|
||
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. | ||
|
||
### Build | ||
|
||
$ npm run build | ||
$ npm run serve | ||
|
||
This command generates static content into the `build` directory. | ||
|
||
<!--- Links --> | ||
|
||
[Web3Signer]: https://github.com/Consensys/web3signer | ||
[common tools wiki]: https://github.com/Consensys/doc.common/wiki | ||
[Web3Signer documentation website hosted by ReadTheDocs.com]: https://docs.web3signer.consensys.net/ |
04365f7
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Successfully deployed to the following URLs:
doc-web3signer – ./
doc-web3signer-infura-web.vercel.app
docs.web3signer.consensys.net
doc-web3signer-git-main-infura-web.vercel.app