Getting started

From an empty folder to a running documentation site in about five minutes.

Install

Notewell ships as a single binary. Download the release for your platform and place it on your PATH:

# Linux / macOS
curl -fsSL https://get.notewell.dev/install.sh | sh

# or with Homebrew
brew install notewell

Verify the installation:

notewell version
# notewell 1.4.2 (linux/amd64)

Create a project

Scaffold a new docs folder. This writes a starter notewell.toml and an example page:

notewell init my-docs
cd my-docs

The layout looks like this:

my-docs/
  notewell.toml      # site configuration
  content/
    index.md         # landing page
    guide/
      install.md
      usage.md
  static/            # images, downloads, anything served as-is

Write a page

Pages are Markdown with optional front-matter. Create content/guide/usage.md:

---
title: Usage
order: 2
---

# Usage

Run the daemon with `notewell serve`. Changes to any
file under `content/` are picked up automatically.

Preview locally

Start the development server. It watches the content folder and live-reloads the browser on save:

notewell serve --watch --addr 127.0.0.1:8080

Open http://127.0.0.1:8080 and you should see your page. Edit a file, hit Cmd+S, and the page refreshes on its own.

Build for production

When you are ready to publish, render the static output once and serve it behind your own web server:

notewell build --out ./public

Copy ./public to any static host, or keep using notewell serve behind a reverse proxy. See the configuration reference for caching and base-path options.