AutoAPMS User Guide

The docs are powered by VitePress. The website is deployed by a GitHub action on every push to the master branch.

Setup

Install Node.js. We recommend the latest LTS version (as for now it's 24). Here is how to do it on Ubuntu:

# Setup the local Ubuntu repository
curl -fsSL https://deb.nodesource.com/setup_24.x | sudo -E sh -

# Install Node.js
sudo apt-get install nodejs -y

# Install dependencies specified in package.json (Run in auto-apms-guide directory)
npm install

For further information, visit the quickstart guide for setting up VitePress.

Build

The project is scaffolded from the root of this repository and supports the following commands:

• Run npm run dev for starting the dev server
• Run npm run build for generating the static HTML site
• Run npm run preview to preview the production build
• Run npm run lint to lint the markdown
• Run npm run lint-fix to lint AND fix the markdown formatting