Skip to content

Generate static HTML websites from markdown using the same style as Agregore's markdown extension

License

Notifications You must be signed in to change notification settings

AgregoreWeb/agregore-markdown-site-generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

agregore-markdown-site-generator

Generate static HTML websites from markdown using the same style as Agregore's markdown extension

Features

  • Renders Github Flavored Markdown to HTML
  • The first heading is used as the HTML document title
  • The first paragraph is used as the HTML document description meta tag
  • Headings get IDs added to them
  • JavaScript attaches anchors to headings so you can click them to add the link to the URL
  • Agregore's CSS theme variables get loaded at runtime (if applicable) so users themes get automatically applied.
  • CSS gets output to style.css if this file doesn't already exist. It's linked to using relative URLs
  • Also renders markdown as Gemtext via .gmi files (with some limitations)

Usage

You can render out all .md files a directory using the CLI tool and npx.

npx agregore-markdown-site-generator ./

You can optionally specify a second parameter for the output directory.

npx agregore-markdown-site-generator ./input ./output

You can also optionally specify a theme.json file to customizing the them for the generated HTML files.

{
  "font-family":"system-ui",
  "background":"#111111",
  "text":"#F2F2F2",
  "primary":"#6e2de5",
  "secondary":"#2de56e",
  "indent":"16px",
  "max-width":"666px"
  }

About

Generate static HTML websites from markdown using the same style as Agregore's markdown extension

Resources

License

Stars

Watchers

Forks

Packages

No packages published