Based on the VuePress blog plugin.

In order to build the website locally, you'll need Node.js >= 14 (or basically the latest LTS version). A prerequisite for the setup-deps.sh script is jq.

The setup is straight forward:

# Install dependencies
npm install

# Serve locally (by default on port 8080)
npm start

There are three types of text highlights that can be used to display different colored boxes.

A green box displaying a friendly tip:

:::tip
foo
:::

A yellow box with a cautious warning:

:::warning
foo
:::

A red box with a clear danger, you can also add a title foo to any container:

:::danger foo
bar
:::

We are using the Vuepress SEO plugin to add relevant meta tags to the site and individual pages.

To improve the meta attributes of a specific page, you can add them as YAML frontmatter like this: (see the WooCommerce page for an example)

---
description: How to integrate BTCPay Server into your WooCommerce store.
tags:
- WooCommerce
- WordPress
- Plugin
- eCommerce
---
# WooCommerce integration

This document explains how to **integrate BTCPay Server into your WooCommerce store**.

To add a YouTube video with a preview, you can so so by linking to it like this:

[![IMAGE ALT TEXT HERE](https://img.youtube.com/vi/YOUTUBE_VIDEO_ID_HERE/mqdefault.jpg)](https://www.youtube.com/watch?v=YOUTUBE_VIDEO_ID_HERE)

Note that the link item need to be a preview image (either from YouTube or a custom one) to result in an embedded video.

The GitHub Actions pipeline checks for broken links after deploying the production site. You can also run the link check locally using npm run linkcheck:local. The dev server needs to be running alongside for this to work.