Skip to content

1.0.0
Compare
Choose a tag to compare
@donuts-are-good donuts-are-good released this 12 Feb 10:05
· 69 commits to master since this release
1.0.0
b39af6d
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode.

bearclaw

🎉🥳🎊 release: bearclaw v1.0.0

release notes

in this release, bearclaw can be run on-demand, or with --watch to watch the current directory's template and markdown directories for changes. bearclaw converts markdown to html, and uses bootstrap for theme.

testing

this code has been tested on GOOS Darwin and GOARCH ARM64. Everything should be fine to run on other systems, please report if you see any issues.

bearclaw

a tiny static site generator, written in Go

what's a static site generator

a static site is a site with no fancy clicky things, signups, comments, just plain html. writing a raw html page for your blog makes it load very fast, but there's a lot of typing involved when designing it. markdown is a simpler and faster way to write pages, and bearclaw converts those markdown files to html for you, with your style template.

no node-modules, no react, no fancy stuff or cool emojis. it just works.

how do we use it?

bearclaw can be run on-demand, or it can rebuild automatically when it sees changes. there are 3 folders: markdown, output, and templates.

  • markdown - all your new posts go here
  • output - bearclaw puts all of your html here
  • templates - header.html and footer.html

that's it! point your webserver at output or handle it however is best for your case.

tip: you can run bearclaw and it will run once, or you can use ./bearclaw --watch to watch the current folder for changes.

issues

if you run in to issues, there's a short bug report form you can fill out, or you can contribute with a pull-request.

greetz

the Dozens, code-cartel, offtopic-gophers, the garrison, and the monster beverage company.

license

this code uses the MIT license, not that anybody cares. If you don't know, then don't sweat it.

made with ☕ by 🍩 😋 donuts-are-good

donate

If you would like to be an official energy drink sponsor of this project, you can contribute however you like.

Bitcoin: bc1qg72tguntckez8qy2xy4rqvksfn3qwt2an8df2n

Monero: 42eCCGcwz5veoys3Hx4kEDQB2BXBWimo9fk3djZWnQHSSfnyY2uSf5iL9BBJR5EnM7PeHRMFJD5BD6TRYqaTpGp2QnsQNgC

😆👏 Thanks

Assets 6
Loading