govuk_markdown 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6d0bb270e6c3987985f3da0f956b8a9871c112cc09ca232715a2440773cd8ab
-  data.tar.gz: 6f34ac1e30578e6c6c912e93fc8c6fd410ace73b73903f7c8141559299832c91
+  metadata.gz: 975a784ccde8bc595764bf9bbff9dc0377b00d43e3114a0870f75fb9a74dc828
+  data.tar.gz: a648e648e2a72505e45f9100a3f4c7599287cca3c0bdd78fb34d5110cfcac62d
 SHA512:
-  metadata.gz: 02aba1d2ccc9623234849df49f3d3fbf90b4b4c180c8e7496d36ca341af39bf16c6cec9a735981906ed94949b21e192fdc200f92f22596f5740db3cb01404d71
-  data.tar.gz: eea2c0cf468653aac44d138fb928292daaaab5fb9d296d1149e6cc28a3ab30a84b2afd7291e47a0ede5a5f5929b5f669a91bc21d5d19adafb7e10cdd6842f75e
+  metadata.gz: a2309375dd6555cc7ca361513a9147844611519ad5c19a765e24a018cab5725faa2d91e50ca7698080d2efa7dc526876096f0ff97f7c7984945ab8da517e7a48
+  data.tar.gz: 8ad79ffc90dae8461e019b18ad5371e94943df3e39d58697089a4a8510d856a1d0859b5b8792f0e4118f99715af106043db4e7ed1b96085794fa58b95f8da7c9

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 2.0.0
+
+* Add test matrix for Ruby versions 2.7.6, 3.0.4 and 3.1.2 
+* Update Publish Gem workflow to run manually
+* Add support for configurable start heading size
+* Add preprocessor for markdown files
+* Add support for inset text component
+* Add support for details component
+* Add pry as developer dependency
+
 ## 1.0.0
 
 * Increase minimum supported Ruby version to >= 2.7.0

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    govuk_markdown (2.0.0)
+    govuk_markdown (2.0.1)
       activesupport
       redcarpet
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.4)
+    activesupport (6.1.7.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -16,22 +16,22 @@ GEM
       zeitwerk (~> 2.3)
     ast (2.4.2)
     coderay (1.1.3)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.2.2)
     diff-lcs (1.4.4)
-    i18n (1.8.10)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
-    minitest (5.14.4)
+    minitest (5.18.0)
     parallel (1.20.1)
     parser (3.0.2.0)
       ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    rack (3.0.0)
+    rack (3.0.7)
     rainbow (3.0.0)
     rake (13.0.6)
-    redcarpet (3.5.1)
+    redcarpet (3.6.0)
     regexp_parser (2.1.1)
     rexml (3.2.5)
     rspec (3.10.0)
@@ -74,10 +74,10 @@ GEM
       rubocop (~> 1.0)
       rubocop-ast (>= 1.1.0)
     ruby-progressbar (1.11.0)
-    tzinfo (2.0.4)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.0.0)
-    zeitwerk (2.4.2)
+    zeitwerk (2.6.7)
 
 PLATFORMS
   ruby

data/README.md

@@ -4,6 +4,8 @@ This Ruby gem converts Markdown into [GOV.UK Frontend](https://github.com/alphag
 
 Don't confuse this gem with [govspeak](https://github.com/alphagov/govspeak), which is a Markdown dialect specifically built for the GOV.UK publishing system (www.gov.uk).
 
+Note that this gem supports [GOV.UK Components](https://github.com/DFE-Digital/govuk-components) version 4.0.0
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -14,6 +16,8 @@ gem 'govuk_markdown'
 
 ## Usage
 
+### Basic usage
+
 ```rb
 GovukMarkdown.render(markdown)
 ```
@@ -32,6 +36,48 @@ Will output:
 </p>
 ```
 
+### Editing the start heading size of headings
+
+By default, H1 headings will be set to XL. You can override the start heading size, for example if you want to start with size L instead.
+
+All subsequent headings i.e. H2, H3, will be sized correctly according to the start heading size. 
+
+Values can be "xl", "l", "m" and "s".
+
+To specify the start heading size for your markdown content, add the below option into your GovukMarkdown.render() method:
+
+```ruby
+GovukMarkdown.render(markdown, headings_start_with: "l")
+```
+
+### Adding inset text to your markdown
+
+To add [inset text](https://govuk-components.netlify.app/components/inset-text/) to your markdown document, use the following tags:
+
+```markdown
+{inset-text}Text to be inset goes here{/inset-text}
+```
+
+The renderer also handles multi-line text as well as multiple paragraphs inside the tags:
+
+```markdown
+{inset-text}
+  Text to be
+  inset goes
+  here
+{/inset-text}
+```
+
+### Adding details sections to your markdown
+
+To add the [details component](https://govuk-components.netlify.app/components/details/) to your markdown, use the following tags:
+
+```markdown
+{details} Find out about the fox and the dog. Whilst the fox is quick and brown, the dog is lazy. {/details}
+```
+
+The first sentence is rendered as the details summary text. The remaining text is rendered as the details text. The renderer handles multiple paragraphs for the details text.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -40,15 +86,6 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 
 You can regenerate the example HTML file from Markdown using `bundle exec rake generate_example`.
 
-## Release a new version
-
-1. Update the version in [lib/govuk_markdown/version.rb](lib/govuk_markdown/version.rb)
-2. Run `bundle install`
-3. Update [CHANGELOG.md](CHANGELOG.md)
-4. Create a pull request
-
-When changes are merged into the `main` branch, a new version will be released using a GitHub action.
-
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/DfE-digital/govuk_markdown.
+Bug reports and pull requests are welcome on GitHub at https://github.com/DfE-digital/govuk-markdown.

data/lib/govuk_markdown/preprocessor.rb

@@ -7,7 +7,7 @@ module GovukMarkdown
     end
 
     def inject_inset_text
-      output.gsub!(build_regexp("inset-text")) do
+      @output = output.gsub(build_regexp("inset-text")) do
         <<~HTML
           <div class="govuk-inset-text">
             #{nested_markdown(Regexp.last_match(1))}
@@ -18,7 +18,7 @@ module GovukMarkdown
     end
 
     def inject_details
-      output.gsub!(build_regexp("details")) do
+      @output = output.gsub(build_regexp("details")) do
         summary, details = *construct_details_from(Regexp.last_match(1))
 
         <<~HTML

data/lib/govuk_markdown/version.rb

@@ -1,3 +1,3 @@
 module GovukMarkdown
-  VERSION = "2.0.0".freeze
+  VERSION = "2.0.1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_markdown
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Tijmen Brommet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-02-15 00:00:00.000000000 Z
+date: 2023-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport