Mineshort Docs

Appearance

Getting Started ​

Goal ​

This page describes the basic setup for Mineshort Docs on docs.mineshort.net.

Requirements ​

  • Ubuntu server

  • Nginx

  • DNS record for docs.mineshort.net

  • Node.js 22+

  • SSL via Certbot

Important Paths ​

  • Project: /opt/mineshort-docs

  • Build output: /opt/mineshort-docs/docs/.vitepress/dist

Build Command ​

bash
cd /opt/mineshort-docs
npm run docs:build

Local Development On The Server ​

bash
cd /opt/mineshort-docs
npm run docs:dev -- --host 127.0.0.1

Next Steps ​

  • Add more markdown pages

  • Extend the sidebar

  • Add custom components

  • Set up CI/CD for automatic builds