CLI

The Notefig CLI converts markdown files into static websites. It handles building, theming, and deployment.

Installation

npm install -g notefig

Or use npx without installing:

npx notefig <command>

Commands

init: Create a new project

notefig init

watch: Start development server

notefig watch

build: Generate static site

notefig build

publish: Deploy to hosting platform

notefig publish vercel
notefig publish netlify
notefig publish s3

Configuration

The CLI reads .metristsrc for settings:

{
  "theme": "default",
  "output": "dist",
  "title": "My Book"
}

CI/CD Integration

The CLI works in any CI environment. Example GitHub Actions workflow:

- name: Build book
  run: npx notefig build
 
- name: Deploy
  run: npx notefig publish vercel

Global Options

• --config <path>: Specify config file location
• --theme <name>: Override theme
• --output <dir>: Override output directory
• --verbose: Detailed logging