<h1 align="center">
<br>
<img src="https://github.com/boykush/scraps/blob/main/assets/logo_opacity.png?raw=true" alt="logo" width="200">
<br>
Scraps
<br>
<br>
</h1>
<p align="center">
<a href="https://boykush.github.io/scraps/"><img alt="Scraps" src="https://img.shields.io/badge/scraps-document?label=document&link=https%3A%2F%2Fboykush.github.io%2Fscraps%2F"></a>
<a href="https://crates.io/crates/scraps"><img src="https://img.shields.io/crates/v/scraps?style=flat-square" /></a>
</p>
# 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](https://boykush.github.io/scraps/).
# Getting Started
You can refer to the [Getting Started](https://boykush.github.io/scraps/scraps/getting-started.html) document to quickly begin using Scraps.
Sample page in Japanese is [here](https://boykush.github.io/wiki/).
# Features
### Static Site
- [x] Sorting (linked_count, committed_date)
- [x] Tagging
- [x] Pagination
- [x] Mermaid Diagrams
- [x] Search
- [x] Color Scheme (Theme is the [Nord](https://www.nordtheme.com/))
- [x] OGP Card
### CLI
- [x] Build a static site
- [x] Init scraps project
- [x] Serve on localhost
- [x] Search scraps content
- [x] List a tags
- [x] Template to generate the scrap
- [x] MCP server for AI assistant integration
### MCP Server
- [x] search_scraps
- [x] list_tags
- [x] lookup_scrap_links
- [x] lookup_scrap_backlinks
- [x] lookup_tag_backlinks
### Deploy
- [x] GitHub Pages
For any feature requests, please feel free to create an [Enhancement feature issue](https://github.com/boykush/scraps/issues/new?assignees=&labels=enhancement&projects=&template=enhancement-feature-template.md&title=).
# License
MIT