Skip to content

Latest commit

 

History

History
108 lines (73 loc) · 2.65 KB

HOWTOSTART.md

File metadata and controls

108 lines (73 loc) · 2.65 KB

How to start your doc ?

Here you will find how to use markdown syntax to create your doc.md file.


Titles and subtitles

  • Title H1 # Title h1

  • Subtitle H2 ## Subtitle H2

  • Subtitle H3 ### Subtitle H3

  • Subtitle H4 #### Subtitle H4


Add image src

You just need to insert this markedown with url of your image. ![img alt](/img/ternoa_logo.png)


Add text

  • Normal : Hello Hello
  • Font-weight : Hello, **Hello**
  • Italic : Hello _Hello_

image


Add Links

To add internal or external link in your doc :


Add a part of code with path

Use ``` your code ``` to generate sample of code with color synthax.

``` jsx title="ternoa-js/account"
// Example
import { generateSeed, getKeyringFromSeed } from "ternoa-js/account";

(async () => {
  const account = await generateSeed()
  const keyring = await getKeyringFromSeed(account.seed)
  const address = keyring.address
  console.log("Your fresh public address is: ", address)
})().catch((e) => {
  console.log(e)
})``` 

image


Add Admonitions

Here, examples you can use for your doc : image

to add admonitions, the synthax markdown is :

:::note

Some **content** with _Markdown_ `syntax`. Check [this `api`](#).

:::
:::tip

Some **content** with _Markdown_ `syntax`. Check [this `api`](#).

:::
:::info

Some **content** with _Markdown_ `syntax`. Check [this `api`](#).

:::
:::caution

Some **content** with _Markdown_ `syntax`. Check [this `api`](#).

:::
:::danger

Some **content** with _Markdown_ `syntax`. Check [this `api`](#).

:::

Mores informations about markdown syntax :

All doc Docusaurus here