Skip to main content

Documentation tutorial

  • 0L Network Documentation repo is based on Docusaurus tool.

  • You can play around with Docusaurus online at docusaurus.new.

Run this repo locally​

  • As a requirement to run Docusaurus locally, you need Node.js version 16.14 or above installed on your machine.
    • When installing Node.js, you are recommended to check all checkboxes related to dependencies.
  • Fork the current repository and clone it.
  • Create a new branch with git branch new_branch_name
# Go to the repository directory in your local machine
cd documentation
# Run the Docusaurus locally
npm run start

The npm run start command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.

Submit your changes​

  • Commit your changes locally, and push them to your forked repository.
  • Go to your GitHub.com repository page and create a pull request to the up-stream repo.