#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

80 releases (14 breaking)

0.15.7 Dec 24, 2024
0.15.1 Nov 18, 2024
0.12.1 Jul 14, 2024
0.10.10 Mar 24, 2024
0.7.9 Jul 23, 2023

#101 in Text processing

Download history 16/week @ 2024-09-13 44/week @ 2024-09-20 15/week @ 2024-09-27 2/week @ 2024-10-04 497/week @ 2024-10-11 183/week @ 2024-10-18 4/week @ 2024-10-25 349/week @ 2024-11-15 47/week @ 2024-11-22 21/week @ 2024-11-29 73/week @ 2024-12-06 27/week @ 2024-12-13 705/week @ 2024-12-20 162/week @ 2024-12-27

976 downloads per month

MIT license

86KB
2K 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