https://github.com/boykush/scraps

A static site generator that builds a wiki from a set of markdown files.
https://github.com/boykush/scraps

cli knowledge-base markdown rust static-site-generator wiki

Last synced: 3 months ago
JSON representation

A static site generator that builds a wiki from a set of markdown files.

• Host: GitHub
• URL: https://github.com/boykush/scraps
• Owner: boykush
• License: mit
• Created: 2023-05-28T13:18:11.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-10T12:46:45.000Z (4 months ago)
• Last Synced: 2024-09-30T01:01:21.452Z (3 months ago)
• Topics: cli, knowledge-base, markdown, rust, static-site-generator, wiki
• Language: Rust
• Homepage: https://boykush.github.io/scraps/
• Size: 1.34 MB
• Stars: 8
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


  


  

  


  Scraps

  


  






  



# 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

- [ ] Search

- [ ] 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