documentation/

directory
v0.5.0-alpha.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 9, 2023 License: Apache-2.0

README

Documentation

The documentation is built using Docusaurus 2. The deployment is done through a centralized build from IOTA WIKI. To run a local instance the IOTA WIKI CLI is used.

Prerequisites

Installation

yarn

This command installs all necessary dependencies.

Local Development

yarn start

This command starts a local, wiki themed development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Including .md file

{@import <file path>}

Example:

{@import ../../../../bindings/wasm/docs/api-reference.md}

Directories

Path Synopsis
tutorial-examples
go

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL