Reference/

CommonMark

commited date: 2025-11-17

Scraps supports Markdown syntax according to the CommonMark specification.

Please refer to the documentation of the pulldown-cmark library used internally for more details.

CommonMark specification - pulldown-cmark guide

Example

In:

# Heading 1
## Heading 2
### Heading 3
#### Heading 4

Out:

Heading 1

Heading 2

Heading 3

Heading 4

Explanation/

README Processing

#Markdown In Scraps, the scraps/README.md file is automatically converted to HTML and included in the static site’s top page ( public/index.html ). For Markdown syntax, please refer to CommonMark. Limitations When using autolink syntax in scraps/README.md, the OGP card described in Autolink will not be displayed. URLs will be displayed as normal links. In: <https://example.com> Out: https://example.com
Tutorial/

Getting Started

Setup Install Scraps Follow the Installation guide to install Scraps on your system Initialize Project Create a new Scraps project using Init: ❯ scraps init my-knowledge-base ❯ cd my-knowledge-base Configure Project Follow Configure Project to set up your Config.toml Content Creation Write Markdown Files Create Markdown files in the /scraps directory Use CommonMark and GitHub-flavored Markdown Add Internal Links Connect documents using Normal Link syntax: [[Page Name]] for simple links [[Page Name|Custom Text]] for custom link text Enhance Content Add Mermaid diagrams for visual representations Use Autolink functionality for external links Organize with context folders when needed Build and Preview Generate Site Use Build to generate static site files: ❯ scraps build Preview Locally Use Serve for local preview and debugging: ❯ scraps serve Deploy Deploy to platforms like Deploy to GitHub Pages when ready AI Integration MCP Server: Enable AI assistant integration using Integrate with AI Assistants for intelligent search and content assistance