Goldsmith-Markdown Goldsmith

golang goldsmith goldsmith-components goldsmith-markdown markdown mit license web

The Goldsmith-Markdown plugin generates partial HTML documents from provided Markdown files.

Usage

This plugin operates on Markdown files. Unlike modules which provide similar functionality for other static site generators, Goldsmith-Markdown does not handle front matter. If your input files include a metadata section, them, they should be first processed by the Goldsmith-FrontMatter plugin.

Although the names of processed files are preserved, the file extensions are modified to .html, reflecting their new format. The generated markup is intended to be used as input to a templating plugin (such as Goldsmith-Layout), and as such is not enclosed in HTML and BODY tags.

The Goldsmith-Markdown plugin can render HTML according to either the original Markdown or the extended CommonMark specifications. You can specify which renderer to use by constructing the plugin either with the markdown.NewBasic and markdown.NewCommon functions respectively.

License

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.