This repo houses the Lisk Docs located at documentation.lisk.com. All documentation related updates and new content will be tracked and maintained in this repo.
The Lisk documentation uses Docusaurus as a documentation site generator.
yarn startThis command starts a local development server and opens up a browser window at localhost:3000/. Most changes are reflected live without having to restart the server.
It is important to test your build locally before deploying it for production. Docusaurus provides a docusaurus serve command for that:
yarn serveBy default, this will load your site at localhost:3000/.
yarn buildThis command generates static content into the build directory and can be served using any static content hosting service.
The following command will automatically Build the docs, and push them to the gh-pages branch.
Changes to this branch are automatically deployed under liskhq.github.io/lisk-documentation/
Using SSH:
USE_SSH=true yarn deployNot using SSH:
GIT_USER=<Your GitHub username> yarn deployCopyright 2016-2024 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
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.