#static-site-generator #markdown #wiki #builds #set #document #page

app scraps

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

66 releases (11 breaking)

0.12.1 Jul 14, 2024
0.11.3 Jun 16, 2024
0.10.10 Mar 24, 2024
0.10.0 Dec 10, 2023
0.7.9 Jul 23, 2023

#109 in Text processing

Download history 126/week @ 2024-03-31 42/week @ 2024-04-07 1/week @ 2024-04-14 558/week @ 2024-05-05 44/week @ 2024-05-12 9/week @ 2024-05-19 3/week @ 2024-05-26 2/week @ 2024-06-02 172/week @ 2024-06-16 1/week @ 2024-06-23 177/week @ 2024-06-30 1/week @ 2024-07-07 126/week @ 2024-07-14

307 downloads per month

MIT license

61KB
1.5K 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
  • Themes (default is the Nord theme)

CLI

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

Deploy

  • GitHub Pages

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

License

MIT

Dependencies

~18–33MB
~476K SLoC