<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="Documentation" src="https://img.shields.io/badge/docs-latest-blue?style=flat-square"></a>
<a href="https://crates.io/crates/scraps"><img alt="Crates.io" src="https://img.shields.io/crates/v/scraps?style=flat-square"></a>
<a href="https://github.com/boykush/scraps/blob/main/LICENSE.md"><img alt="License" src="https://img.shields.io/badge/license-MIT-blue?style=flat-square"></a>
<a href="https://github.com/boykush/scraps/actions/workflows/cargo-test-and-lint.yml"><img alt="CI" src="https://img.shields.io/github/actions/workflow/status/boykush/scraps/cargo-test-and-lint.yml?branch=main&style=flat-square"></a>
<a href="https://github.com/boykush/scraps"><img alt="GitHub Stars" src="https://img.shields.io/github/stars/boykush/scraps?style=social"></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.tutorial.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=).
# 📸 Screenshots
### Generated Static Site
<img src="https://github.com/boykush/scraps/blob/main/assets/dark_mode.png?raw=true" alt="Static Site Dark Mode" width="800">
*Search, pagination, and Wiki-link navigation with Nord theme (Dark Mode)*
<details>
<summary>Light Mode</summary>
<img src="https://github.com/boykush/scraps/blob/main/assets/light_mode.png?raw=true" alt="Static Site Light Mode" width="800">
</details>
# 🤝 Contributing
We welcome contributions! 🎉
See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines on how to contribute to Scraps.
## Ways to Contribute
- 🐛 [Report bugs](https://github.com/boykush/scraps/issues/new?template=bug-report-template.md)
- 💡 [Request features](https://github.com/boykush/scraps/issues/new?template=enhancement-feature-template.md)
- 📖 [Improve documentation](https://github.com/boykush/scraps/tree/main/docs)
- 🔧 Submit pull requests
By participating, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md).
# 📄 License
MIT