diff --git a/CHANGELOG.md b/CHANGELOG.md index b858126..0930833 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,23 +2,28 @@ ## Released +### [0.2.1] - 2023-08-21 + +- Bump heading sizes down a level [#12](https://github.com/alphagov/govuk-forms-markdown/pull/12/) + ### [0.2.0] - 2023-08-015 + - All links should open in a new tab [#9](https://github.com/alphagov/govuk-forms-markdown/issues/9) ### [0.1.0] - 2023-08-03 - Initial release - Adds custom render methods for markdown syntax we would like to support. - + - Heading levels 2 & 3, anything else returns as unstyled text - - Links styled like GOV.UK + - Links styled like GOV.UK - Lists (ordered and unordered) + - We do not support the following - + - Heading level 1 - tables - horizontal rules - emphasis - code blocks - custom HTML - diff --git a/Gemfile.lock b/Gemfile.lock index 459d4d6..db56a7b 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,7 +1,7 @@ PATH remote: . specs: - govuk-forms-markdown (0.2.0) + govuk-forms-markdown (0.2.1) redcarpet (~> 3.6) GEM diff --git a/lib/govuk-forms-markdown/renderer.rb b/lib/govuk-forms-markdown/renderer.rb index 8d38986..19b963d 100644 --- a/lib/govuk-forms-markdown/renderer.rb +++ b/lib/govuk-forms-markdown/renderer.rb @@ -11,8 +11,8 @@ def initialize(options = {}) def header(text, header_level) heading_size = case header_level - when 2 then "l" - when 3 then "m" + when 2 then "m" + when 3 then "s" end if heading_size.nil? diff --git a/lib/govuk-forms-markdown/version.rb b/lib/govuk-forms-markdown/version.rb index f91a9e1..89d1c3d 100644 --- a/lib/govuk-forms-markdown/version.rb +++ b/lib/govuk-forms-markdown/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module GovukFormsMarkdown - VERSION = "0.2.0" + VERSION = "0.2.1" end diff --git a/spec/govuk-forms-markdown/govuk_forms_markdown_spec.rb b/spec/govuk-forms-markdown/govuk_forms_markdown_spec.rb index 8965ae0..34c3d0a 100644 --- a/spec/govuk-forms-markdown/govuk_forms_markdown_spec.rb +++ b/spec/govuk-forms-markdown/govuk_forms_markdown_spec.rb @@ -29,11 +29,11 @@ end it "renders H2s and GOV.UK classes" do - expect(render("## Top heading")).to eq('

Top heading

') + expect(render("## Top heading")).to eq('

Top heading

') end it "renders H3s with ids and GOV.UK classes" do - expect(render("### A heading")).to eq('

A heading

') + expect(render("### A heading")).to eq('

A heading

') end it "renders paragraphs with GOV.UK classes" do @@ -91,7 +91,7 @@ context "when unsafe content is used it should be escaped" do it "renders escaped H2s and GOV.UK classes" do - expect(render("## ")).to eq('

<script>alert('Hacked');</script>

') + expect(render("## ")).to eq('

<script>alert('Hacked');</script>

') end it "renders escaped p and GOV.UK classes" do diff --git a/spec/govuk-forms-markdown/renderer/header_spec.rb b/spec/govuk-forms-markdown/renderer/header_spec.rb index 8b179ef..6fe0b5c 100644 --- a/spec/govuk-forms-markdown/renderer/header_spec.rb +++ b/spec/govuk-forms-markdown/renderer/header_spec.rb @@ -17,7 +17,7 @@ supported_heading_levels = [2, 3] supported_heading_levels.each do |level| it "does format heading level #{level}" do - heading_size = level == 2 ? "l" : "m" + heading_size = level == 2 ? "m" : "s" expect(renderer.header("Heading level #{level}", level).strip).to eq "Heading level #{level}" end end