Skip to content

LiskHQ/lisk-docs

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

54110b4 · Jan 6, 2025
Nov 19, 2024
Jan 6, 2025
Nov 25, 2024
Nov 25, 2024
Nov 29, 2024
Nov 12, 2024
Jan 5, 2024
Dec 21, 2023
Jan 25, 2024
Jan 5, 2024
Feb 22, 2024
Nov 29, 2024
Sep 6, 2024
Sep 6, 2024
Jan 6, 2025
Sep 6, 2024

Repository files navigation

Lisk Documentation

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.

Managing Docs

Local Development

yarn start

This 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.

Local Building

It is important to test your build locally before deploying it for production. Docusaurus provides a docusaurus serve command for that:

yarn serve

By default, this will load your site at localhost:3000/.

Build

yarn build

This command generates static content into the build directory and can be served using any static content hosting service.

Deployment

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 deploy

Not using SSH:

GIT_USER=<Your GitHub username> yarn deploy

License

Copyright 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.