search

iotaledger / iota-wiki

IOTA Wiki
https://wiki.iota.org
Other
118 stars 285 forks source link
docusaurus-v2 guides iota website wiki

readme

[![Contributors][contributors-shield]][contributors-url] [![Forks][forks-shield]][forks-url] [![Stargazers][stars-shield]][stars-url] [![Issues][issues-shield]][issues-url] [![Gitpod][gitpod-shield]][gitpod-url]

IOTA Wiki GitHub Banner

EXPLORE THE WIKI

Report Error · Request Topic

Table of Contents

About the Project

The IOTA Wiki is a central hub for entering into the IOTA ecosystem. A community driven initiative to provide an up-to-date collection of introductions and further reading about the technology, the teams, the community, and everything in between. So anyone can learn how to build, adopt, and engage with IOTA, all in one space.

Built With

The IOTA Wiki is built using TypeScript, ReactJS and Docusaurus v2.0.

Getting Started

Prerequisites

Preview Locally

To preview the Wiki locally, use the following steps. For more detailed scripts, see Pre-configured scripts for reference.

Please note that the Wiki has a lot of content, so currently the initial build is taking a while. Effort is taken to try and reduce the build time in the future.

  1. Clone the repository by running git clone https://github.com/iotaledger/iota-wiki.git and go to the directory with cd iota-wiki.
  2. Install dependencies with yarn.
  3. Prepare the environment by running yarn prepare, this has to be done only once.
  4. Preview the Wiki with yarn start, this will start a development server serving the Wiki with hot reload capability, so it will update content after any changes were made.

Pre-configured scripts

Script Explanation
prepare Prepare the environment by checking out submodules build.
start Start a development server serving the Wiki, with hot reloading on changes.
start:section:{section} Start a development server serving only a section of the Wiki, with hot reloading on changes. Available sections are build, get-started, learn, and maintain.
build Build the Wiki. To build for production, checkout the latest version of external documentation by running yarn checkout:remote and set the MODE environment variable to production.
checkout:remote Check out the latest version of external documentation.
generate:api Generate available API documentation configured through the Docusaurus OpenAPI plugin and by compiling documentation from source code.

Contributing

The IOTA Wiki is maintained by the IF and community contributions are always welcome. The DX team and related teams from the IF will review all issues and pull requests posted to this repository. If you notice any mistakes, or feel something is missing, feel free to create an issue to discuss with the team or directly create a pull request with suggestions. Here is a basic workflow to open a pull request:

  1. Fork this repository to your own account and clone it (git clone https://github.com/<YOUR_USERNAME>/iota-wiki.git)
  2. Create a feature branch for your changes (git checkout -b feat/amazing-feature).
  3. Make your changes and optionally preview them locally.
  4. Run yarn format and yarn lint and fix any remaining errors and warnings.
  5. Commit your changes (git commit -m 'Add some amazing feature').
  6. Push your changes to your fork (git push origin feat/amazing-feature).
  7. Open a pull request to the main branch of this repository.

Have a look at CONTRIBUTING for further guidance.

Versioning

To find out how to version your docs, read this guide.

Online one-click setup for contributing

You can use Gitpod (a free, online, VS Code-like IDE) for contributing. With a single click it will prepare everything you need to build and contribute to the Wiki. Just click on this button and skip step 1 from above.

Open in Gitpod

Contact

Phylo - Phyloiota - Phylo [Community DAO - lets go!]#2233
Jeroen van den Hout - jlvandenhout - jvdhout#4402
Dr.Electron - Dr-Electron - Dr.Electron#9370
Critical - kilianhln - Critical#7111
JSto - JSto91 - JSto#3746