| 1 | # sitedown changelog
|
| 2 |
|
| 3 | All notable changes to this project will be documented in this file.
|
| 4 |
|
| 5 | The format is based on [Keep a Changelog](https://keepachangelog.com).
|
| 6 |
|
| 7 | This project adheres to [Semantic Versioning](https://semver.org).
|
| 8 |
|
| 9 | ## [5.1.0](https://github.com/ungoldman/sitedown/releases/v5.1.0) - 2022-05-06
|
| 10 |
|
| 11 | ### Features
|
| 12 |
|
| 13 | - add `dev` option to start local development server
|
| 14 | - add `assets` option to copy any asset files to build
|
| 15 |
|
| 16 | ## [5.0.3](https://github.com/ungoldman/sitedown/releases/v5.0.3) - 2022-04-21
|
| 17 |
|
| 18 | ### Fixes
|
| 19 |
|
| 20 | - ignore documentation artifacts (page.png, docs/) when publishing
|
| 21 |
|
| 22 | ## [5.0.2](https://github.com/ungoldman/sitedown/releases/v5.0.2) - 2022-04-21
|
| 23 |
|
| 24 | ### Fixes
|
| 25 |
|
| 26 | - explicitly set minimum node version to 14 in `engines` field of `package.json`
|
| 27 |
|
| 28 | Minimum node version was already 14 since [v5.0.0](https://github.com/ungoldman/sitedown/releases/v5.0.0). This patch makes it more obvious to downstream module consumers.
|
| 29 |
|
| 30 | ## [5.0.1](https://github.com/ungoldman/sitedown/releases/v5.0.1) - 2022-03-13
|
| 31 |
|
| 32 | ### Fixes
|
| 33 |
|
| 34 | - deps: standard@16
|
| 35 | - Bump highlight.js from 10.7.3 to 11.5.0 (#40)
|
| 36 | - Bump event-stream from 3.3.4 to 4.0.1 (#43)
|
| 37 | - ci: target latest Node LTS only (16)
|
| 38 | - ci: rm automerge (broken)
|
| 39 | - Bump gh-release from 4.0.4 to 6.0.1 (#42)
|
| 40 | - use github actions status badge
|
| 41 | - ownership transfer fixes & updates (#39)
|
| 42 |
|
| 43 | ## [5.0.0](https://github.com/ungoldman/sitedown/releases/v5.0.0) - 2020-12-09
|
| 44 |
|
| 45 | ### Breaking
|
| 46 |
|
| 47 | - Update all dependencies to their latest version.
|
| 48 | - Only test on Node 14 and 15. Older versions may work, bymmv.
|
| 49 | - Older versions of Node are no longer supported.
|
| 50 |
|
| 51 | ## [4.0.0](https://github.com/ungoldman/sitedown/releases/v4.0.0) - 2019-01-15
|
| 52 |
|
| 53 | ### Breaking
|
| 54 |
|
| 55 | - 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.
|
| 56 |
|
| 57 | ## [3.3.2](https://github.com/ungoldman/sitedown/releases/v3.3.2) - 2018-11-26
|
| 58 |
|
| 59 | ### Fixes
|
| 60 |
|
| 61 | - Pin event-stream to eliminate malicious package threat (#32)
|
| 62 |
|
| 63 | ## [3.3.1](https://github.com/ungoldman/sitedown/releases/v3.3.1) - 2018-08-06
|
| 64 |
|
| 65 | ### Fixes
|
| 66 |
|
| 67 | - Fix default layout css
|
| 68 |
|
| 69 | ## [3.3.0](https://github.com/ungoldman/sitedown/releases/v3.3.0) - 2017-09-05
|
| 70 |
|
| 71 | ### Features
|
| 72 |
|
| 73 | - add `markdown-it-github-headings` under `--github-headings` option (#22) (#28)
|
| 74 |
|
| 75 | ## [3.2.1](https://github.com/ungoldman/sitedown/releases/v3.2.1) - 2017-09-03
|
| 76 |
|
| 77 | ### Fixes
|
| 78 |
|
| 79 | - use shorter unpkg url for style.css
|
| 80 |
|
| 81 | ## [3.2.0](https://github.com/ungoldman/sitedown/releases/v3.2.0) - 2017-09-01
|
| 82 |
|
| 83 | ### Features
|
| 84 |
|
| 85 | - add style.css to default layout (#26)
|
| 86 | - add option for custom target element (#15)
|
| 87 |
|
| 88 | ## [3.1.1](https://github.com/ungoldman/sitedown/releases/v3.1.1) - 2016-11-28
|
| 89 |
|
| 90 | [view diff](https://github.com/ungoldman/sitedown/compare/v3.1.0...v3.1.1)
|
| 91 |
|
| 92 | ### Fixes
|
| 93 |
|
| 94 | - hotfix: rewrite nested README links to index URLs
|
| 95 |
|
| 96 | ## [3.1.0](https://github.com/ungoldman/sitedown/releases/v3.1.0) - 2016-11-11
|
| 97 |
|
| 98 | [view diff](https://github.com/ungoldman/sitedown/compare/v3.0.1...v3.1.0)
|
| 99 |
|
| 100 | ### Additions
|
| 101 | - add layout to watched files (#17)
|
| 102 | - expose `sitedown.watch` method
|
| 103 |
|
| 104 | ### Changes
|
| 105 | - use `path.resolve` instead of `cwp`
|
| 106 |
|
| 107 | ## [3.0.1](https://github.com/ungoldman/sitedown/releases/v3.0.1) - 2016-09-17
|
| 108 |
|
| 109 | [view diff](https://github.com/ungoldman/sitedown/compare/v3.0.0...v3.0.1)
|
| 110 |
|
| 111 | ### Fixes
|
| 112 | - bugfix: disable autolinking for filenames (just `.md` for now)
|
| 113 |
|
| 114 | ## [3.0.0](https://github.com/ungoldman/sitedown/releases/v3.0.0) - 2016-09-17
|
| 115 |
|
| 116 | [view diff](https://github.com/ungoldman/sitedown/compare/v2.2.0...v3.0.0)
|
| 117 |
|
| 118 | ### Fixes
|
| 119 | - bugfix: add meta viewport to default layout
|
| 120 | - bugfix: trim whitespace in title text
|
| 121 |
|
| 122 | ### Breaking Changes
|
| 123 | - append markdown html instead of overwriting `.markdown-body` element contents
|
| 124 | - update `markdown-it` to `^8.0.0`
|
| 125 | - use lots of `markdown-it` plugins and options
|
| 126 | - [markdown-it-sub](https://github.com/markdown-it/markdown-it-sub)
|
| 127 | - [markdown-it-sup](https://github.com/markdown-it/markdown-it-sup)
|
| 128 | - [markdown-it-footnote](https://github.com/markdown-it/markdown-it-footnote)
|
| 129 | - [markdown-it-deflist](https://github.com/markdown-it/markdown-it-deflist)
|
| 130 | - [markdown-it-emoji](https://github.com/markdown-it/markdown-it-emoji)
|
| 131 | - [markdown-it-ins](https://github.com/markdown-it/markdown-it-ins)
|
| 132 | - [markdown-it-mark](https://github.com/markdown-it/markdown-it-mark)
|
| 133 | - [markdown-it-abbr](https://github.com/markdown-it/markdown-it-abbr)
|
| 134 | - switch from [markdown-it-highlightjs](https://github.com/valeriangalliat/markdown-it-highlightjs) to built-in `highlight` option
|
| 135 | - use `typographer` option properly
|
| 136 |
|
| 137 | ## [2.2.0]
|
| 138 | - use `<main>` instead of `<div>` for default layout (#13)
|
| 139 | - add barely acceptable watch option to cli (#9)
|
| 140 |
|
| 141 | ## [2.1.2]
|
| 142 | - bugfix: rewrite `/readme.md` links to `/`
|
| 143 | - bugfix: rewrite links correctly when `pretty: false` (e.g. `guide.md` -> `guide.html`)
|
| 144 | - ci: expand test coverage to node versions `4`, `5`, and `6`
|
| 145 |
|
| 146 | ## [2.1.1]
|
| 147 | - bugfix: only use text from first h1 for title
|
| 148 |
|
| 149 | ## [2.1.0]
|
| 150 | - bugfix: allow lowercase readme
|
| 151 | - feature: allow disabling directory indexes (pretty: false)
|
| 152 |
|
| 153 | ## [2.0.1]
|
| 154 | - bugfix: ensure default layout is used if layout.html does not exist in cwd (#7)
|
| 155 |
|
| 156 | ## [2.0.0]
|
| 157 | - breaking: use pretty URLs (`$f.md` converts to `$f/index.html` instead of `$f.html`)
|
| 158 | - breaking: rename `sitedown.fileToPageBody` to `sitedown.mdToHtml`
|
| 159 | - breaking: use single `layout.html` instead of `header.html` and `footer.html`
|
| 160 | - parsed markdown content is injected into `.markdown-body`
|
| 161 | - text from first `h1` is injected into `title`
|
| 162 |
|
| 163 | ## [1.1.0]
|
| 164 | - avoid rewriting external links to MDs (#3)
|
| 165 | - generate CSS classes for highlightjs support (#4)
|
| 166 |
|
| 167 | ## 1.0.0
|
| 168 | - engage
|
| 169 |
|
| 170 | [2.2.0]: https://github.com/ungoldman/sitedown/compare/v2.1.2...v2.2.0
|
| 171 | [2.1.2]: https://github.com/ungoldman/sitedown/compare/v2.1.1...v2.1.2
|
| 172 | [2.1.1]: https://github.com/ungoldman/sitedown/compare/v2.1.0...v2.1.1
|
| 173 | [2.1.0]: https://github.com/ungoldman/sitedown/compare/v2.0.1...v2.1.0
|
| 174 | [2.0.1]: https://github.com/ungoldman/sitedown/compare/v2.0.0...v2.0.1
|
| 175 | [2.0.0]: https://github.com/ungoldman/sitedown/compare/v1.1.0...v2.0.0
|
| 176 | [1.1.0]: https://github.com/ungoldman/sitedown/compare/v1.0.0...v1.1.1
|