wing-wing
/
goldfinch
1
0
Fork 0
Code Releases 2 Wiki Activity
154 Commits
5 Branches
5 Tags
144 KiB
Go 87.7%
HTML 7.6%
CSS 4.7%
 
 
 
Go to file
wing 5927950463 Add dependencies to README 
FossilOrigin-Name: 6dd8b8ec722a96ae6cca0cc897a9596ff0d13c6f3f4b5b8716c0ffaf8d1524ea
 		2023-10-15 16:39:21 +00:00
templates/default Remove old pandoc styling from default theme 2023-10-13 22:32:38 +00:00
LICENSE Add README, LICENCE, go.mod and go.sum 2023-10-10 18:02:45 +00:00
README.md Add dependencies to README 2023-10-15 16:39:21 +00:00
config.go Use default logger in config.go as custom one can't be created before the config is read 2023-10-11 21:21:15 +00:00
db.go Add appendIndex to pages tables and page struct 2023-10-11 22:39:46 +00:00
example-config.yaml Renamed all "statement" variables to "query" 2023-10-10 15:58:09 +00:00
go.mod Add README, LICENCE, go.mod and go.sum 2023-10-10 18:02:45 +00:00
go.sum Add README, LICENCE, go.mod and go.sum 2023-10-10 18:02:45 +00:00
main.go Add "/rebuild" handle 2023-10-09 23:46:30 +00:00
pages.go Goldmark now loads extensions 2023-10-13 21:59:49 +00:00
routes.go Check if page wants to append an index and add it to tmplData. Update page.html to include indexes 2023-10-11 22:48:30 +00:00

README.md

goldfinch

goldfinch builds and serves websites written in markdown and/or mycomarkup files via an SQLite database. I made it to replace my old static site generator so it primarily exists for my own use, though feel free to use or modify it however you want.

Features

  • Generate HTML pages from markdown or mycomarkup
  • Auto generated index pages
  • Templates using Go's template engine
  • Unlisted and private (protected by URL token) pages
  • Tags
  • RSS feeds

Pages in the content folder are rendered to markdown and saved in an SQLite database. All pages take a default template but will use other templates based on the root directory. For example, if you make "blog" folder and a "blog.html" template, all pages in the folder will the template of the same name.

Visiting the URL for any root folder will display a generated list of pages that it contains, excluding pages marked as unlisted or private.

A special "/tags" route exists to list all the tags used and how many pages each one is used on. Clicking on a tag will list all associated pages.

Multiple RSS feeds can be generated based on folders.

Visit the the wiki for more information on usage.

Dependencies

goldfinch requires the following packages: