#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

74 releases (14 breaking)

0.15.1 Nov 18, 2024
0.14.3 Nov 16, 2024
0.12.1 Jul 14, 2024
0.10.10 Mar 24, 2024
0.7.9 Jul 23, 2023

#131 in Text processing

Download history 18/week @ 2024-09-15 42/week @ 2024-09-22 17/week @ 2024-09-29 618/week @ 2024-10-13 65/week @ 2024-10-20 1/week @ 2024-10-27 61/week @ 2024-11-10 319/week @ 2024-11-17 18/week @ 2024-11-24

398 downloads per month

MIT license

81KB
2K SLoC


logo
Scraps

Scraps documentation

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 document to quickly begin using Scraps.

Sample page in Japanese is here.

Features

Static Site

  • Sorting (linked_count, committed_date)
  • Tagging
  • Pagination
  • 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

~19–31MB
~463K SLoC