markugen
Version:
Markdown to HTML/PDF static site generation tool
96 lines (95 loc) • 5.47 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<meta content="width=device-width, initial-scale=1" name="viewport">
<title>Change Log v2</title>
<link rel="stylesheet" href="markugen.css">
</head>
<body>
<h1 id="change-log-v2">Change Log v2</h1>
<p>This page will be updated with changes to Markugen upon each new release.
The log was started at version 2.0.0 and will be continued for each new release
moving forward.</p>
<h2 id="v204">v2.0.4</h2>
<p>This is a minor bug fix for the <code>--pdf-only</code> flag. In previous versions, this
flag would cause the output directory to be completely removed.</p>
<h2 id="v203">v2.0.3</h2>
<p>This version has some bug fixes related to assets and some new features.</p>
<ul>
<li>Favicon bug that was causing the path to be absolute is now fixed.</li>
<li>Template expansion is now allowed in CSS and JS provided files along with
CSS and JS provided strings. See
<a class="markugen-md-link" href="./Features/Preprocessor.html#template-expansion">Template Expansion</a>
in the Preprocessor section for more details.</li>
<li>A new flag was added to the <a class="markugen-md-link" href="./Command-Line-Interface.html">CLI</a> that allows
setting of the dynamic variables used in template expansion: <code>--vars</code>. The
flag takes a path to a JSON file with a JSON object where each key in the
object represents a variable in template expansion.</li>
<li>The save to file icon in code that is imported from a file has been
returned to its original working state.</li>
<li>A new flag was added to the <a class="markugen-md-link" href="./Command-Line-Interface.html">CLI</a> that allows
setting of the CLI options via a config file: <code>--config</code>.</li>
<li>The <code>--input</code> flag is no longer required when using the
<a class="markugen-md-link" href="./Command-Line-Interface.html">CLI</a>, it will default to the current working
directory.</li>
</ul>
<h2 id="v202">v2.0.2</h2>
<p>This is another bug fix release. The following bugs were fixed in this release:</p>
<ul>
<li>Assets that were given as file paths and not directory paths were causing an
error to be thrown due to the target being a directory. File paths now work
just the same as directory paths.</li>
<li>The text portion of a Markdown link was not being parsed as Markdown which
resulted in the raw form of the text. The links now get parsed and
interpreted properly.</li>
<li>Markdown links who's text contains the link will have the extension replaced
with the appropriate extension (html) in the text as well as the href.</li>
</ul>
<h2 id="v201">v2.0.1</h2>
<p>This is a bug fix release. The primary bug fixed in this release deals with
Markdown that is given as a string for input instead of a file. Release
v2.0.0 outputs a file path in the HTML and causes some strange behavior in
the output. This release fixes the bug and produces normal output.</p>
<p>Additionally, a unit test was added that ensures this behavior is tested
in all future releases.</p>
<h2 id="v200">v2.0.0</h2>
<p>This is the first release of the Markugen 2.x series. </p>
<h3 id="markugen-class">Markugen Class</h3>
<p>The increment of the major version is due to some changes to the main
function calls within the<code>Markugen</code> class. the following is a list of the
major changes to the <code>Markugen</code> class:</p>
<ul>
<li><code>Markugen.generateSync</code> no longer exists.<ul>
<li>The asynchronous version <code>Markugen.generate</code> exists and should be used in
most cases.</li>
<li>A synchronous version still exists for generating HTML from Markdown files,
but this version ignores the use of the <code>--pdf</code> option and has been renamed
to <code>Markugen.mdtohtml</code>.</li>
<li>PDF output can now be generated independent of the HTML generation by using
the <code>Markugen.htmltopdf</code> method or the <code>markugen pdf</code> subcommand of the cli</li>
</ul>
</li>
<li>The <code>Markugen</code> constructor only takes options specific to <code>Markugen</code> and no
longer accepts the <code>generate</code> options. Instead, the options for <code>generate</code>
are provided with the call to <code>Markugen.generate</code>, <code>Markugen.mdtohtml</code>, and
<code>Markugen.htmltopdf</code>.</li>
</ul>
<h3 id="relative-assets">Relative Assets</h3>
<p>Previous releases required all assets to be relative to the <code>--input</code> directory;
however, this release allows for <code>--assets</code> and <code>--favicon</code> to contain
absolute paths and are <strong>not</strong> required to be relative to the <code>--input</code>
directory. Paths to assets may contain directories and/or files. Paths that
are provided as absolute paths will be copied to the root of the <code>--output</code>
directory.</p>
<h3 id="pdf-subcommand-for-cli">PDF Subcommand for CLI</h3>
<p>The Command Line Interface (CLI) has a new subcommand called <code>htmltopdf</code> or just
<code>pdf</code>. The subcommand allows for the <code>Markugen</code> CLI to be used for converting
HTML files to PDF files independent of the Markdown to HTML generation that is
the default and main use case for <code>Markugen</code>. More information can be found
in the
<a class="markugen-md-link" href="./Command-Line-Interface.html#subcommands">Command Line Interface Subcommands</a>
section of teh documentation.</p>
<script src="markugen.js"></script>
</body>
</html>