This guide covers using Scraps as a static site generator (SSG).

Setup

1. Install Scraps

   • Follow the Installation guide to install Scraps on your system

2. Initialize Project

   • Create a new Scraps project using Init:

     ❯ scraps init my-knowledge-base
     ❯ cd my-knowledge-base
     

3. Configure Project

   • Follow Configuration to set up your .scraps.toml

Content Creation

1. Write Markdown Files

   • Create Markdown files in the /scraps directory
   • Use CommonMark and GitHub-flavored Markdown

2. Add Internal Links

   • Connect documents using Normal Link syntax:
     • [[Page Name]] for simple links
     • [[Page Name|Custom Text]] for custom link text

3. Enhance Content

   • Add Mermaid diagrams for visual representations
   • Use Autolink functionality for external links
   • Organize with context folders when needed

Build and Preview

1. Generate Site

   • Use Build to generate static site files:

     ❯ scraps build
     

2. Preview Locally

   • Use Serve for local preview and debugging:

     ❯ scraps serve
     

3. Deploy

   • Deploy to platforms like Deploy to GitHub Pages when ready

Quality Check

• Lint: Use Lint to check wiki-link quality:

  ❯ scraps lint
  

AI Integration

• MCP Server: Enable AI assistant integration using Integrate with AI Assistants for intelligent search and content assistance