<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 documentation" src="https://img.shields.io/badge/scraps-documentation-fc0060?style=flat-square"></a>
</p>
# What is this?
Scraps is a static site generator that builds a wiki from a set of markdown files.
You can refer to the [Getting Started](https://boykush.github.io/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
- [ ] Themes (default is the [Nord](https://www.nordtheme.com/) theme)
### CLI
- [x] Build a static site
- [x] Init scraps project
- [x] Serve on localhost
### 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