#static-site-generator #wiki #markdown #set #knowledge-base #builds #document

app scraps

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

81 releases (15 breaking)

new 0.16.0 Jan 11, 2025
0.15.7 Dec 24, 2024
0.15.1 Nov 18, 2024
0.12.1 Jul 14, 2024
0.7.9 Jul 23, 2023

#74 in Text processing

Download history 29/week @ 2024-09-25 9/week @ 2024-10-02 138/week @ 2024-10-09 530/week @ 2024-10-16 16/week @ 2024-10-23 308/week @ 2024-11-13 86/week @ 2024-11-20 6/week @ 2024-11-27 30/week @ 2024-12-04 87/week @ 2024-12-11 598/week @ 2024-12-18 269/week @ 2024-12-25 152/week @ 2025-01-08

1,019 downloads per month

MIT license

96KB
2.5K SLoC


logo
Scraps

Scraps documentation

What is the Scraps?

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

You can refer to the Overview 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
  • Themes (default is the Nord theme)

CLI

  • Build a static site
  • Init scraps project
  • Serve on localhost
  • List a tags

Deploy

  • GitHub Pages

For any feature requests, please feel free to create an Enhancement feature issue.

License

MIT

Dependencies

~20–32MB
~478K SLoC