Getting started

To get started, open a new shell and run:

npx create-document

This will create a new folder called documents with a few document templates.

Commands

document dev

Starts a local development server that will watch your files and automatically rebuild your document when you make changes.

npx skrift dev

document export

Generates the plain HTML files of your documents into a out directory.

npx skrift export

Setting Up the Environment

When working in the CLI, a lot of friction can get introduced with installing it and rebuilding for every change. To avoid that, we have a script that can be linked globally to directly run the source code of the CLI. You can use it the same as you would the standard CLI.

1. Link skrift globally

pnpm link ./dev -g

2. Run the CLI

document-dev [command] [flags]

License

MIT License