Skip to content

Commit

Permalink
docs(Add documentation website):
Browse files Browse the repository at this point in the history
  • Loading branch information
carte7000 committed Sep 13, 2019
1 parent 6783b06 commit b403769
Show file tree
Hide file tree
Showing 15 changed files with 7,412 additions and 1 deletion.
1 change: 1 addition & 0 deletions .circleci/config.yml
Expand Up @@ -25,6 +25,7 @@ jobs:
- image: circleci/node:8.11.4
steps:
- checkout
- run: cd website && npm run build && cp -R build/tezos-ts ../dist
- run: npm install
- run: npm run lerna -- bootstrap
- run: npm run lerna run build
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Expand Up @@ -9,5 +9,5 @@ dist
compiled
.awcache
.rpt2_cache
docs
website/build/
!.vscode/extensions.json
25 changes: 25 additions & 0 deletions docs/inmemory_signer.md
@@ -0,0 +1,25 @@
---
title: In Memory Signer
author: Simon Boissonneault-Robert
---

> **Warning use carefuly**
In memory signer is a local signer implementation that allows you to directly use a private key in your browser.

This signer implementation is mean't to be used for development and not for production use case

## Usage

```js

import { InMemorySigner } from '@tezos-ts/signer'
import { Tezos } from '@tezos-ts/tezos-ts'

Tezos.setProvider({signer: new InMemorySigner('you_private_key')})
```

If you configure tezos-ts this way you will now be able to use every function that needs signing support

`Note: Operation will be signed automatically using the signer (no prompt)`

68 changes: 68 additions & 0 deletions docs/quick_start.md
@@ -0,0 +1,68 @@
---
title: Quick start
author: Simon Boissonneault-Robert
---

## Installing the library

```
npm run install @tezos-ts/tezos-ts
```

## Import the library in your project

```js
import { Tezos } from '@tezos-ts/tezos-ts'
```

## Configuration

### Changing the underlying rpc

```js
Tezos.setProvider({rpc: "your_rpc"})
```

### Changing the underlying signer

```js
import { TezBridgeSigner } from '@tezos-ts/tezbridge-signer';

Tezos.setProvider({signer: new TezBridgeSigner()})
```

## Example

### Get balance

```js
Tezos.contract.getBalance('your_address')
```

### Get balance history

```js
Tezos.query.balanceHistory('your_address')
```


### Transfer

`Note: This require a signer to be configured`

```js
const op = await Tezos.contract.transfer({to: 'tz1', amount: 2'})
await op.confirmation()
```
### Interact with a smart contract
`Note: This require a signer to be configured`
```js
const contract = await Tezos.contract.at('your_address')
const operation = contract.methods.mint('tz1', 100).send({ fee: 20000 })
await operation.confirmation()
```
17 changes: 17 additions & 0 deletions docs/tezbridge_signer.md
@@ -0,0 +1,17 @@
---
title: TezBridge Signer
author: Simon Boissonneault-Robert
---

## Usage

You first need to include <script src="https://www.tezbridge.com/plugin.js"></script> in your application to use this signer

```js
import { TezBridgeSigner } from '@tezos-ts/tezbridge-signer'
import { Tezos } from '@tezos-ts/tezos-ts'

Tezos.setProvider({signer: new TezBridgeSigner()})
```

For more information on how to use TezBridge see https://docs.tezbridge.com/
193 changes: 193 additions & 0 deletions website/README.md
@@ -0,0 +1,193 @@
This website was created with [Docusaurus](https://docusaurus.io/).

# What's In This Document

* [Get Started in 5 Minutes](#get-started-in-5-minutes)
* [Directory Structure](#directory-structure)
* [Editing Content](#editing-content)
* [Adding Content](#adding-content)
* [Full Documentation](#full-documentation)

# Get Started in 5 Minutes

1. Make sure all the dependencies for the website are installed:

```sh
# Install dependencies
$ yarn
```
2. Run your dev server:

```sh
# Start the site
$ yarn start
```

## Directory Structure

Your project file structure should look something like this

```
my-docusaurus/
docs/
doc-1.md
doc-2.md
doc-3.md
website/
blog/
2016-3-11-oldest-post.md
2017-10-24-newest-post.md
core/
node_modules/
pages/
static/
css/
img/
package.json
sidebar.json
siteConfig.js
```

# Editing Content

## Editing an existing docs page

Edit docs by navigating to `docs/` and editing the corresponding document:

`docs/doc-to-be-edited.md`

```markdown
---
id: page-needs-edit
title: This Doc Needs To Be Edited
---

Edit me...
```

For more information about docs, click [here](https://docusaurus.io/docs/en/navigation)

## Editing an existing blog post

Edit blog posts by navigating to `website/blog` and editing the corresponding post:

`website/blog/post-to-be-edited.md`
```markdown
---
id: post-needs-edit
title: This Blog Post Needs To Be Edited
---

Edit me...
```

For more information about blog posts, click [here](https://docusaurus.io/docs/en/adding-blog)

# Adding Content

## Adding a new docs page to an existing sidebar

1. Create the doc as a new markdown file in `/docs`, example `docs/newly-created-doc.md`:

```md
---
id: newly-created-doc
title: This Doc Needs To Be Edited
---

My new content here..
```

1. Refer to that doc's ID in an existing sidebar in `website/sidebar.json`:

```javascript
// Add newly-created-doc to the Getting Started category of docs
{
"docs": {
"Getting Started": [
"quick-start",
"newly-created-doc" // new doc here
],
...
},
...
}
```

For more information about adding new docs, click [here](https://docusaurus.io/docs/en/navigation)

## Adding a new blog post

1. Make sure there is a header link to your blog in `website/siteConfig.js`:

`website/siteConfig.js`
```javascript
headerLinks: [
...
{ blog: true, label: 'Blog' },
...
]
```

2. Create the blog post with the format `YYYY-MM-DD-My-Blog-Post-Title.md` in `website/blog`:

`website/blog/2018-05-21-New-Blog-Post.md`

```markdown
---
author: Frank Li
authorURL: https://twitter.com/foobarbaz
authorFBID: 503283835
title: New Blog Post
---

Lorem Ipsum...
```

For more information about blog posts, click [here](https://docusaurus.io/docs/en/adding-blog)

## Adding items to your site's top navigation bar

1. Add links to docs, custom pages or external links by editing the headerLinks field of `website/siteConfig.js`:

`website/siteConfig.js`
```javascript
{
headerLinks: [
...
/* you can add docs */
{ doc: 'my-examples', label: 'Examples' },
/* you can add custom pages */
{ page: 'help', label: 'Help' },
/* you can add external links */
{ href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
...
],
...
}
```

For more information about the navigation bar, click [here](https://docusaurus.io/docs/en/navigation)

## Adding custom pages

1. Docusaurus uses React components to build pages. The components are saved as .js files in `website/pages/en`:
1. If you want your page to show up in your navigation header, you will need to update `website/siteConfig.js` to add to the `headerLinks` element:

`website/siteConfig.js`
```javascript
{
headerLinks: [
...
{ page: 'my-new-custom-page', label: 'My New Custom Page' },
...
],
...
}
```

For more information about custom pages, click [here](https://docusaurus.io/docs/en/custom-pages).

# Full Documentation

Full documentation can be found on the [website](https://docusaurus.io/).

0 comments on commit b403769

Please sign in to comment.