Scraps Doc

Getting Started

commited date: 2025-05-31

Setup

Begin with Installation of Scraps, then Init a new project and customize the Configuration to match your preferences.

Content Creation

Write Markdown files in the /scraps directory using CommonMark specification and GitHub-flavored Markdown. Enhance your content with Mermaid diagrams, Autolink functionality, and Internal Link connections between documents.

Build and Deploy

Use Build to generate static site files, Serve for local preview and debugging, then deploy to platforms like GitHub Pages.