Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

agregore-markdown-site-generator

Package Overview
Dependencies
Maintainers
0
Versions
5
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

agregore-markdown-site-generator

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

  • 1.2.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
23
increased by283.33%
Maintainers
0
Weekly downloads
 
Created
Source

agregore-markdown-site-generator

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

Features

  • Renders Github Flavored Markdown
  • 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 anchros 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.

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": "var(--ag-color-black)",
  "text": "var(--ag-color-white)",
  "primary": "var(--ag-color-purple)",
  "secondary": "var(--ag-color-green)",
  "indent": "16px",
  "max-width": "666px"
}

Keywords

FAQs

Package last updated on 03 Dec 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc