Getting Started

commited date: 2024-06-21

Installation

❯ cargo install scraps

❯ brew install boykush/tap/scraps

git command is required for features

❯ scraps init your-scraps-project
❯ cd your-scraps-project

The output result will look like this

❯ tree -a -L 1
.
├── .git
├── .gitignore
├── Config.toml
└── scraps

Edit Config.toml to settings.

title = "your scraps project"

See Configuration for other config.

Write markdown files under /scraps dir.

❯ tree scraps
scraps
├── Getting Started.md
└── Scraps.md

See Scraps for scraps notation in markdown files.

❯ scraps build

The output will be a slugged html file as follows.

❯ tree public
public
├── getting-started.html
├── scraps.html
├── index.html
└── main.css

❯ scraps serve

You can debug the build outputs by visiting http://127.0.0.1:1112