Scraps Doc

Getting Started

commited date: 2025-08-03

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

    • Customize the Configuration in Config.toml
    • Set your site title, base URL, and other preferences

Content Creation

  1. Write Markdown Files

  2. Add Internal Links

    • Connect documents using Internal Link syntax:
      • [[Page Name]] for simple links
      • [[Page Name|Custom Text]] for custom link text
  3. Enhance Content

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