https://github.com/eyedeekay/edgar

generates a homepage for anything with a readme. A replacement for my endless makefile nonsense.
https://github.com/eyedeekay/edgar

css html markdown static-site-generator

Last synced: 1 day ago
JSON representation

generates a homepage for anything with a readme. A replacement for my endless makefile nonsense.

• Host: GitHub
• URL: https://github.com/eyedeekay/edgar
• Owner: eyedeekay
• License: mit
• Created: 2022-07-30T23:54:55.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-02-07T16:23:22.000Z (9 months ago)
• Last Synced: 2024-08-02T15:47:24.302Z (3 months ago)
• Topics: css, html, markdown, static-site-generator
• Language: Go
• Homepage: https://eyedeekay.github.io/edgar
• Size: 462 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
edgar

=====

generates a homepage for anything with a readme. A replacement for my endless makefile nonsense.

This tool is intended to create pages for projects which are based on the README.md file, and

I hope it's particularly useful for github pages.

Basically, a really simple static site generator that take a directory full of markdown files and emits

reasonable-looking HTML pages for them.

```sh

rm -f edgar

wget https://github.com/eyedeekay/edgar/releases/download/v0.34.6/edgar

sudo cp edgar /usr/bin/edgar

sudo chmod +x /usr/bin/edgar

```

STATUS: This project is maintained. I will respond to issues, pull requests, and feature requests within a few days. It does

what it's supposed to do.