Skip to content
/ scraps Public

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

License

Notifications You must be signed in to change notification settings

boykush/scraps


logo
Scraps

Documentation Crates.io License CI GitHub Stars

πŸ“š 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.

πŸ“Έ Screenshots

Generated Static Site

Static Site Dark Mode

Search, pagination, and Wiki-link navigation with Nord theme (Dark Mode)

Light Mode Static Site Light Mode

🀝 Contributing

We welcome contributions! πŸŽ‰

See CONTRIBUTING.md for detailed guidelines on how to contribute to Scraps.

Ways to Contribute

By participating, you agree to abide by our Code of Conduct.

πŸ“„ License

MIT

About

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

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors 6