chore: fix other.yml

Release 1.3.0

.github/ISSUE_TEMPLATE/cpp-bug-report.yml

@@ -37,7 +37,9 @@ body:
       label: maddy version
       description: What version of maddy are you using?
       options:
-        - 1.2.0 (latest)
+        - 1.3.0 (latest)
+        - 1.2.1
+        - 1.2.0
         - 1.1.2
         - 1.1.1
         - 1.1.0

.github/ISSUE_TEMPLATE/markdown-bug-report.yml

@@ -37,7 +37,9 @@ body:
       label: maddy version
       description: What version of maddy are you using?
       options:
-        - 1.2.0 (latest)
+        - 1.3.0 (latest)
+        - 1.2.1
+        - 1.2.0
         - 1.1.2
         - 1.1.1
         - 1.1.0
@@ -51,7 +53,7 @@ body:
     id: example
     attributes:
       label: Minimal Mardown example
-      description: To be able to reproduce your issue, please give some example Markdown which creates problems.
+      description: To be able to reproduce your issue, please give some example Markdown which creates problems. Please indent the Markdown by 4 spaces.
     validations:
       required: true
   - type: textarea

.github/ISSUE_TEMPLATE/other.yml

@@ -0,0 +1,10 @@
+name: Other
+description: Anything that doesn't fit into one of the other issue categories
+body:
+  - type: textarea
+    id: whats-up
+    attributes:
+      label: What is the issue?
+      description: Is some tooling not working? Performance issues? ...
+    validations:
+      required: true

.github/workflows/run-tests.yml

@@ -4,9 +4,11 @@ on:
   push:
     branches:
       - master
+      - dev
   pull_request:
     branches:
       - master
+      - dev
 jobs:
   test-on-ubuntu:
     runs-on: ubuntu-latest

CHANGELOG.md

@@ -16,6 +16,10 @@ maddy uses [semver versioning](https://semver.org/).
 
 * ?
 
+## version 1.3.0 2023-08-26
+
+* ![**ADDED**](https://img.shields.io/badge/-ADDED-%23099) Headlines can have inline parsing now. It is on by default, but can be disabled by config.
+
 ## version 1.2.1 2023-08-06
 
 * ![**FIXED**](https://img.shields.io/badge/-FIXED-%23090) Parser.h version() method clashing with VERSION defines at global scope

README.md

@@ -1,7 +1,7 @@
 # maddy
 
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![Version: 1.2.1](https://img.shields.io/badge/Version-1.2.1-brightgreen.svg)](https://semver.org/)
+[![Version: 1.3.0](https://img.shields.io/badge/Version-1.3.0-brightgreen.svg)](https://semver.org/)
 
 maddy is a C++ Markdown to HTML **header-only** parser library.
 

include/maddy/headlineparser.h

@@ -57,9 +57,11 @@ public:
    */
   HeadlineParser(
     std::function<void(std::string&)> parseLineCallback,
-    std::function<std::shared_ptr<BlockParser>(const std::string& line)> getBlockParserForLineCallback
+    std::function<std::shared_ptr<BlockParser>(const std::string& line)> getBlockParserForLineCallback,
+    bool isInlineParserAllowed = true
   )
     : BlockParser(parseLineCallback, getBlockParserForLineCallback)
+    , isInlineParserAllowed(isInlineParserAllowed)
   {}
 
   /**
@@ -103,7 +105,7 @@ protected:
   bool
   isLineParserAllowed() const override
   {
-    return false;
+    return this->isInlineParserAllowed;
   }
 
   void
@@ -131,6 +133,9 @@ protected:
       line = std::regex_replace(line, hlRegex[i], hlReplacement[i]);
     }
   }
+
+private:
+  bool isInlineParserAllowed;
 }; // class HeadlineParser
 
 // -----------------------------------------------------------------------------

include/maddy/parser.h

@@ -57,7 +57,7 @@ public:
    * Check https://github.com/progsource/maddy/blob/master/CHANGELOG.md
    * for the changelog.
   */
-  static const std::string& version() { static const std::string v = "1.2.1"; return v; }
+  static const std::string& version() { static const std::string v = "1.3.0"; return v; }
 
   /**
    * ctor
@@ -287,10 +287,22 @@ private:
       maddy::HeadlineParser::IsStartingLine(line)
     )
     {
-      parser = std::make_shared<maddy::HeadlineParser>(
-        nullptr,
-        nullptr
-      );
+      if (!this->config || this->config->isHeadlineInlineParsingEnabled)
+      {
+        parser = std::make_shared<maddy::HeadlineParser>(
+          [this](std::string& line){ this->runLineParser(line); },
+          nullptr,
+          true
+        );
+      }
+      else
+      {
+        parser = std::make_shared<maddy::HeadlineParser>(
+          nullptr,
+          nullptr,
+          false
+        );
+      }
     }
     else if (
       (

include/maddy/parserconfig.h

@@ -70,11 +70,22 @@ struct ParserConfig
   */
   bool isHTMLWrappedInParagraph;
 
+  /**
+   * en-/disable headline inline-parsing
+   *
+   * default: enabled
+  */
+  bool isHeadlineInlineParsingEnabled;
+
+  /**
+   * enabled parsers bitfield
+  */
   uint32_t enabledParsers;
 
   ParserConfig()
     : isEmphasizedParserEnabled(true)
     , isHTMLWrappedInParagraph(true)
+    , isHeadlineInlineParsingEnabled(true)
     , enabledParsers(maddy::types::DEFAULT)
   {}
 }; // class ParserConfig

tests/maddy/test_maddy_parser.cpp

@@ -64,3 +64,34 @@ TEST(MADDY_PARSER, ItShouldParseWithSmallConfig)
 
   ASSERT_EQ(testHtml3, output);
 }
+
+TEST(MADDY_PARSER, ItShouldParseInlineCodeInHeadlines)
+{
+  const std::string headlineTest = R"(
+# Some **test** markdown
+)";
+  const std::string expectedHTML = "<h1>Some <strong>test</strong> markdown</h1>";
+  std::stringstream markdown(headlineTest);
+
+  auto parser = std::make_shared<maddy::Parser>();
+
+  const std::string output = parser->Parse(markdown);
+
+  ASSERT_EQ(expectedHTML, output);
+}
+
+TEST(MADDY_PARSER, ItShouldNotParseInlineCodeInHeadlineIfDisabled)
+{
+  const std::string headlineTest = R"(
+# Some **test** markdown
+)";
+  const std::string expectedHTML = "<h1>Some **test** markdown</h1>";
+  std::stringstream markdown(headlineTest);
+  auto config = std::make_shared<maddy::ParserConfig>();
+  config->isHeadlineInlineParsingEnabled = false;
+  auto parser = std::make_shared<maddy::Parser>(config);
+
+  const std::string output = parser->Parse(markdown);
+
+  ASSERT_EQ(expectedHTML, output);
+}