sitedown changelog
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog.
This project adheres to Semantic Versioning.
5.0.3 - 2022-04-21
Fixes
- ignore documentation artifacts (page.png, docs/) when publishing
5.0.2 - 2022-04-21
Fixes
- explicitly set minimum node version to 14 in
engines
field ofpackage.json
Minimum node version was already 14 since v5.0.0. This patch makes it more obvious to downstream module consumers.
5.0.1 - 2022-03-13
Fixes
- deps: standard@16
- Bump highlight.js from 10.7.3 to 11.5.0 (#40)
- Bump event-stream from 3.3.4 to 4.0.1 (#43)
- ci: target latest Node LTS only (16)
- ci: rm automerge (broken)
- Bump gh-release from 4.0.4 to 6.0.1 (#42)
- use github actions status badge
- ownership transfer fixes & updates (#39)
5.0.0 - 2020-12-09
Breaking
- Update all dependencies to their latest version.
- Only test on Node 14 and 15. Older versions may work, bymmv.
- Older versions of Node are no longer supported.
4.0.0 - 2019-01-15
Breaking
- Add correct hljs css class to code blocks to fully support hljs theme backgrounds. Since this could change how your site looks if you are using hljs, this is a breaking change. Use the
--no-hljs-class
flag to disable this css class.
3.3.2 - 2018-11-26
Fixes
- Pin event-stream to eliminate malicious package threat (#32)
3.3.1 - 2018-08-06
Fixes
- Fix default layout css
3.3.0 - 2017-09-05
Features
- add
markdown-it-github-headings
under--github-headings
option (#22) (#28)
3.2.1 - 2017-09-03
Fixes
- use shorter unpkg url for style.css
3.2.0 - 2017-09-01
Features
- add style.css to default layout (#26)
- add option for custom target element (#15)
3.1.1 - 2016-11-28
Fixes
- hotfix: rewrite nested README links to index URLs
3.1.0 - 2016-11-11
Additions
- add layout to watched files (#17)
- expose
sitedown.watch
method
Changes
- use
path.resolve
instead ofcwp
3.0.1 - 2016-09-17
Fixes
- bugfix: disable autolinking for filenames (just
.md
for now)
3.0.0 - 2016-09-17
Fixes
- bugfix: add meta viewport to default layout
- bugfix: trim whitespace in title text
Breaking Changes
- append markdown html instead of overwriting
.markdown-body
element contents - update
markdown-it
to^8.0.0
- use lots of
markdown-it
plugins and options- markdown-it-sub
- markdown-it-sup
- markdown-it-footnote
- markdown-it-deflist
- markdown-it-emoji
- markdown-it-ins
- markdown-it-mark
- markdown-it-abbr
- switch from markdown-it-highlightjs to built-in
highlight
option - use
typographer
option properly
2.2.0
- use
<main>
instead of<div>
for default layout (#13) - add barely acceptable watch option to cli (#9)
2.1.2
- bugfix: rewrite
/readme.md
links to/
- bugfix: rewrite links correctly when
pretty: false
(e.g.guide.md
->guide.html
) - ci: expand test coverage to node versions
4
,5
, and6
2.1.1
- bugfix: only use text from first h1 for title
2.1.0
- bugfix: allow lowercase readme
- feature: allow disabling directory indexes (pretty: false)
2.0.1
- bugfix: ensure default layout is used if layout.html does not exist in cwd (#7)
2.0.0
- breaking: use pretty URLs (
$f.md
converts to$f/index.html
instead of$f.html
) - breaking: rename
sitedown.fileToPageBody
tositedown.mdToHtml
- breaking: use single
layout.html
instead ofheader.html
andfooter.html
- parsed markdown content is injected into
.markdown-body
- text from first
h1
is injected intotitle
- parsed markdown content is injected into
1.1.0
- avoid rewriting external links to MDs (#3)
- generate CSS classes for highlightjs support (#4)
1.0.0
- engage