Scraps

commited date: 2023-10-18

Internal links like wiki

Specifying the name of the markdown file with a notation such as [[Link]] will generate a wiki-like internal link.

For example, if you have the following set of files.

❯ tree scraps
scraps
├── Overview.md
└── Usage.md

Fill in the file name in the scraps directory in Overview.md as follows to generate the link.

See [[Usage]] for detail.

Tags as nonexistent links

If there is no scraps with the specified title, such as [[Link]], then it will be a tag.

Tags are lined up on the index page, and the link is to a page with a list of scraps that have the tag.

Getting Started

Installation ❯ cargo install scraps mac OS ❯ brew install boykush/tap/scraps Init project 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 Configuration Edit Config.toml to settings. title = "your scraps project" See Configuration for other config. Write scraps Write markdown files under /scraps dir. ❯ tree scraps scraps ├── Getting Started.md └── Scraps.md See Scraps for scraps notation in markdown files. Build static site ❯ scraps build The output will be a slugged html file as follows. ❯ tree public public ├── getting-started.html ├── scraps.html ├── index.html └── main.css Debug server ❯ scraps serve You can debug the build outputs by visiting http://127.0.0.1:1112 Deploy pages See Deploy.