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

   • Open Config.toml in your project directory
   • Edit the required fields:

     base_url = "https://yourusername.github.io/your-repository/"
     title = "My Knowledge Base"
     

   • Customize other Configuration options as needed

Content Creation

1. Write Markdown Files

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

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

   • 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 GitHub Pages when ready

AI Integration

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