IOTA documentation website - PRs welcome!
Switch branches/tags
Clone or download
l3wi Merge pull request #44 from stevexm/patch-1
Update what-is-iri.mdx / minor typo correction
Latest commit 5f32d18 Dec 11, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
components Merge: Pull latest dev into branch Dec 3, 2018
lib Merge pull request #44 from stevexm/patch-1 Dec 11, 2018
pages Merge pull request #44 from stevexm/patch-1 Dec 11, 2018
scripts Modify for MDX Jun 26, 2018
static Update diagram Nov 26, 2018
.eslintignore Add support for new static path prefixes in front. Aug 30, 2017
.gitignore Upgraded prettier Jan 16, 2018
.travis.yml
ci-prod.json Update CI Logic Jul 3, 2018
ci-staging.json Update CI Logic Jul 3, 2018
env-config.js Add support for new static path prefixes in front. Aug 30, 2017
license.md Lowercased text files Sep 9, 2017
next.config.js
package.json Update packages Aug 22, 2018
readme.md README repo URL changed from gitlab to github Dec 7, 2018
yarn.lock Fix merge Dec 3, 2018

readme.md

IOTA Documentation

This is the public documentation to introduce IOTA.
You can access this documentation online at https://docs.iota.org/ .

Running Locally

Download the copy of this repostory.

git clone https://github.com/iotaledger/docs.git

Then visit to the downloaded repository and install dependencies with:

npm install

Then you can run the app with: (The app is written in Next.js)

npm run dev

Now the documentation is running at http://localhost:5800

Editing Docs Content

You can find the source of the documentation inside the pages directory. Documentation is mostly written in markdown with the help of some React components.

Those components give us additional features which are not available in markdown.

Adding New Docs

You can start writing the new docs page by adding it to the pages directory starting with the following code:

import { withRouter } from 'next/router'
import WithMDX from '../../../lib/with-mdx'

import { TerminalInput } from "../../../components/text/terminal"

export const page = {
title: 'Example Page',
date: '19 Feburary 2018',
editUrl: 'pages/path/for-editing/on-github.mdx',
}

export default withRouter(props => WithMDX(props, page))

# H1 Title

This is the content written in Markdown.

<TerminalInput># this is how we show the terminal input</TerminalInput>x

Then you can add it to the sidebar by editing the file located at: lib/data/docs.js.

These docs use MDX: a powerful parser, loader and renderer for JSX. See how the library works here.

Adding Images and Assets

You can add images and assets into the static directory. Always try to avoid using hosted images. If you are creating a new docs page, keep you images inside a subdirectory under static/docs.

New Components

Always try to use the existing components and features in markdown. Create a new component or use a component from NPM, unless there is no other option.

Submitting Changes / New Doc Pages

You can simply send a PR. It's simple as that.