Quick Start Guide

Get up and running with MinimalDoc in minutes

Prerequisites

Before installing MinimalDoc, ensure you have:

  • A terminal/command line interface
  • Basic familiarity with Markdown

Installation

Download the latest binary for your platform:

curl -sSL \
  https://github.com/studiowebux/minimaldoc/releases/latest/download/minimaldoc-$(uname -s)-$(uname -m) \
  -o minimaldoc
chmod +x minimaldoc

Create Your First Site

Initialize a new documentation project:

./minimaldoc init my-docs
cd my-docs

Build and Preview

Generate your static site:

../minimaldoc build

Your documentation is now available in the public/ directory.

Next Steps