README.md

YScope Docs

This repo contains the source for YScope's docs hub at docs.yscope.com.

Development

Follow the steps below to build and view the site locally.

Requirements

• Node.js >= 16 to be able to view the output
• python3 >= 3.10
• python3-venv
• Task

Building

• Build the site incrementally:

  task docs:build

  • The output of the build will be in build/html.

• Clean-up the build:

  task clean

Viewing the output

task docs:serve