Previewing the docs locally

To verify the correct presentation of the modified content, the docs can be previewed locally by compiling them with Antora.

Previewing content changes

In the editor

Many IDEs support the preview of AsciiDoc files.

WebStorm

Install the AsciiDoc plugin: https://plugins.jetbrains.com/plugin/7391-asciidoc

In browser

cd lisk-docs/build

Create a new folder

mkdir local

Run local playbook

antora preview-site.yml --fetch

Preview in browser

open local/index.html

Previewing UI changes

  1. Navigate to the ui/ folder

    cd lisk-docs/ui

  2. Start the local preview

    gulp preview

Open http://localhost:5252/ in the browser.

Any changes in the UI source code will be directly reflected in the browser.
See UI preview for more information.