This repository contains the Lisk documentation, accessible at https://docs.lisk.com. It tracks and maintains all updates and new content related to the documentation. The documentation for Lisk is generated using Docusaurus as the site generator.
-
Clone the
lisk-docsrepository to your computer. -
Install all the dependencies by executing the following:
yarn install -
To run a local instance of docs, execute:
yarn startThis command starts a local development server and opens a browser window at http://localhost:3000/. Most changes are reflected live without having to restart the server.
It is essential to test your build & serve it locally before submitting it for review.
To build the docs, execute the following:
yarn build
This command generates static content into the build directory and can be served using any static content hosting service.
Docusaurus provides a serve command to deploy your built files locally:
yarn serve
By default, this will load your site at http://localhost:3000/. You'll have to build and serve again if any changes are made.
Would you like to contribute? Please see which situation fits you best.
- When should you create an issue?
- How do you create a pull request?
- Do you want to help us translate our docs? Check out our Translation Tracker to see which PRs were recently merged and need translation.
However you contribute, please update the Translation Tracker to ensure your changes can be translated for our native readers.
Check out our contributors.
The following table lists all the recently created/updated pull requests for the English version.
If you attempt to translate any of the following documents, please note that each PR's corresponding locale files should be updated according to the language.
If a new file is created in the English version and does not exist in the translated docs folder, i.e., i18n/, then create a new file in the same directory inside the i18n/ parent folder and name it exactly as it is in the English version.
Once translated, the PR entry in the following table should be removed, and the translation PR should be submitted for review.
| Pull Request | Indonesian |
|---|---|
| [LISKDOCS-11] Add Remix guide | ✖ |
| [LISKDOCS-19] Introduction to Web3 app development | ✖ |
| [LISKDOCS-37] Add Tenderly nodes | ✖ |
| [LISKDOCS-38] Update node guide | ✖ |
Copyright 2016-2025 Onchain Foundation
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at Apache License, Version 2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.