/

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 single markdown file and emits reasonable-looking HTML page for it.

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.

Usage 

# Usage of ./edgar:
  -author string
    	The author of the HTML file (default is your git namespace)
  -css string
    	The CSS file to use, a default will be generated if one doesn't exist (default "style.css")
  -filename string
    	The markdown file to convert to HTML (default "README.md")
  -out string
    	The name of the output file (default "index.html")
  -script string
    	The script file to use (default "script.js")
  -snowflake
    	add a snowflake to the page footer (default true)
  -title string
    	The title of the HTML file
Get the source code:
Show license 
MIT License

Copyright (c) 2022 idk

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Hide license
I2P