What is Scraps?

Scraps is a portable CLI knowledge hub for managing interconnected Markdown documentation with Wiki-link notation.

Learn more in the official documentation.

Getting Started

You can refer to the Getting Started document to quickly begin using Scraps.

Sample page in Japanese is here.

Features

Static Site

• Sorting (linked_count, committed_date)
• Tagging
• Pagination
• Mermaid Diagrams
• Search
• Color Scheme (Theme is the Nord)
• OGP Card

CLI

• Build a static site
• Init scraps project
• Serve on localhost
• Search scraps content
• List a tags
• Template to generate the scrap
• MCP server for AI assistant integration

MCP Server

• search_scraps
• list_tags
• lookup_scrap_links
• lookup_scrap_backlinks
• lookup_tag_backlinks

Deploy

• GitHub Pages

For any feature requests, please feel free to create an Enhancement feature issue.

License

MIT