https://github.com/boykush/scraps
A static site generator that makes it easy to write internal links (Wiki links) in Markdown files.
https://github.com/boykush/scraps
cli knowledge-management markdown personal-knowledge-management rust static-site-generator wiki
Last synced: 5 months ago
JSON representation
A static site generator that makes it easy to write internal links (Wiki links) in Markdown files.
- Host: GitHub
- URL: https://github.com/boykush/scraps
- Owner: boykush
- License: mit
- Created: 2023-05-28T13:18:11.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-20T07:19:31.000Z (over 1 year ago)
- Last Synced: 2025-03-20T07:37:23.868Z (over 1 year ago)
- Topics: cli, knowledge-management, markdown, personal-knowledge-management, rust, static-site-generator, wiki
- Language: Rust
- Homepage: https://boykush.github.io/scraps/
- Size: 2.22 MB
- Stars: 21
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Scraps
# 📚 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] 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
*Search, pagination, and Wiki-link navigation with Nord theme (Dark Mode)*
Light Mode
# 🤝 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