Skip to content

Commit ee2fc6d

Browse files
committed
Prepare to release v2.0.0
1 parent b280807 commit ee2fc6d

File tree

4 files changed

+25
-7
lines changed

4 files changed

+25
-7
lines changed

CHANGELOG.md

+20-1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,24 @@ This applies from version 0.5.0 onwards, as some versions before that have broke
1212
## [Unreleased]
1313

1414
### Added
15+
### Changed
16+
### Fixed
17+
### Removed
18+
19+
## [2.0.0] - 2023-02-20
20+
21+
The main change in this release is that it introduces support for a _Markdown-based syntax_. Using that syntax, term definitions can now contain multiple paragraphs, bold/italic text, ordered/unordered lists, hyperlinks, images, code fragments, and more.
22+
23+
### How to upgrade from v1 and switch to Markdown
24+
25+
1. Point the [static assets](https://github.com/hilverd/glossary-page-template#static-assets) to a version starting with `@2`.
26+
2. When making changes, open Settings at the top of the page and switch the input syntax to Markdown.
27+
3. Inspect all term definitions and correct the formatting where needed.
28+
29+
### Added
30+
31+
- Support a [Markdown](https://commonmark.org/help/)-based syntax for term descriptions.
32+
- This uses [elm-markdown](https://github.com/dillonkearns/elm-markdown) which implements [GitHub Flavored Markdown](https://github.github.com/gfm/).
1533

1634
- Add a "Settings" section on the list page which allows changing the following.
1735
- How "compact" the overall layout is by adjusting the card widths.
@@ -386,7 +404,8 @@ Make the [relevant changes](https://github.com/hilverd/glossary-page-template/co
386404

387405
- Initial release.
388406

389-
[Unreleased]: https://github.com/hilverd/glossary-page-template/compare/v1.9.0...HEAD
407+
[Unreleased]: https://github.com/hilverd/glossary-page-template/compare/v2.0.0...HEAD
408+
[2.0.0]: https://github.com/hilverd/glossary-page-template/compare/v1.9.0...v2.0.0
390409
[1.9.0]: https://github.com/hilverd/glossary-page-template/compare/v1.8.6...v1.9.0
391410
[1.8.6]: https://github.com/hilverd/glossary-page-template/compare/v1.8.5...v1.8.6
392411
[1.8.5]: https://github.com/hilverd/glossary-page-template/compare/v1.8.4...v1.8.5

README.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@ Download `glossary.html` from the [latest release](https://github.com/hilverd/gl
1717
The `glossary.html` file points to `glstatic.net` for static assets hosted using Cloudflare:
1818

1919
```
20-
https://glstatic.net/glossary-page-template@1/glossary.min.js
21-
https://glstatic.net/glossary-page-template@1/glossary.min.css
20+
https://glstatic.net/glossary-page-template@2/glossary.min.js
21+
https://glstatic.net/glossary-page-template@2/glossary.min.css
2222
```
2323

24-
These files are cached for 24 hours and get updated with any releases with a [major version number](https://semver.org/) of `1`. Alternatively you can change the URL to point to e.g. `@1.1` which gets all patch releases with version numbers of the form `1.1.x`. You can also specify a specific version such as `1.0.1` -- these are cached forever.
24+
These files are cached for 24 hours and get updated with any releases with a [major version number](https://semver.org/) of `2`. Alternatively you can change the URL to point to e.g. `@2.0` which gets all patch releases with version numbers of the form `2.0.x`. You can also use a specific version such as `2.0.1` -- these are cached forever.
2525

2626
#### Security considerations
2727

@@ -39,5 +39,4 @@ You can get the `hash-here` values from the [release notes](https://github.com/h
3939

4040
## Limitations
4141

42-
* At the moment the template only supports plain text definitions consisting of a single (possibly long) paragraph for each definition.
4342
* The integrated editor UI is meant to be run and used by a single local user only. It is not designed to be exposed to untrusted users.

elm-application.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "hilverd/glossary-page-template",
33
"summary": "Create a glossary as a single HTML page hosted anywhere.",
4-
"version": "1.9.0",
4+
"version": "2.0.0",
55
"exposed-modules": [
66
"ApplicationShell",
77
"Data.AboutLink",

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "glossary-page-template",
3-
"version": "1.9.0",
3+
"version": "2.0.0",
44
"description": "Create a glossary as a single HTML page hosted anywhere.",
55
"private": true,
66
"author": "Hilverd Reker",

0 commit comments

Comments
 (0)