Skip to content

filoozom/docs

 
 

Repository files navigation

Helium Documentation

This is currently a work in progress, please see developer.helium.com for current docs.

Documentation for the Helium network.

Requirements

Installation

$ yarn

Local Development

$ yarn start

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

Contributing

Documentation is managed by Helium, but supported by the community.

Please see CONTRIBUTING.md for more instructions.

Editing an Existing Doc

Use the style guide found here to learn what markdown syntax is available.

For more advanced content consider using JSX.

Adding Images

When adding images, use the method shown below.

---
id: my-doc
title: My Doc
---

// Add to the top of the file below the front matter.
import useBaseUrl from '@docusaurus/useBaseUrl';

...

<img alt="Image Description" src={useBaseUrl('img/image.svg')} />

Adding a New Doc

Create a new *.mdx extension file following the existing naming conventions.

Attribution

This website is built using Docusaurus 2, a modern static website generator.

About

Helium Documentation

Resources

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • CSS 53.1%
  • JavaScript 46.9%