mirror of
https://github.com/progsource/maddy.git
synced 2026-03-24 23:40:39 +01:00
docs: update version number
This commit is contained in:
2
.github/workflows/run-tests.yml
vendored
2
.github/workflows/run-tests.yml
vendored
@@ -25,6 +25,7 @@ jobs:
|
||||
- name: run tests
|
||||
run: |
|
||||
./build/MaddyTests
|
||||
|
||||
test-on-windows:
|
||||
runs-on: windows-latest
|
||||
steps:
|
||||
@@ -42,6 +43,7 @@ jobs:
|
||||
- name: run tests
|
||||
run: |
|
||||
./build/Debug/MaddyTests.exe
|
||||
|
||||
test-on-osx:
|
||||
runs-on: macos-latest
|
||||
steps:
|
||||
|
||||
@@ -20,11 +20,12 @@ maddy uses [semver versioning](https://semver.org/).
|
||||
*  gtest is now loaded via cmake and not a git submodule any longer - updated gtest version to 1.13.0
|
||||
*  tests are only run if the cmake option `MADDY_BUILD_WITH_TESTS` is on, moved test cmake code to the `tests` subfolder
|
||||
*  travis CI and appveyor
|
||||
*  GitHub workflow
|
||||
*  GitHub workflow for tests
|
||||
*  config flags `isEmphasizedParserEnabled` and `isHTMLWrappedInParagraph`
|
||||
*  config flag `enabledParsers` to en-/disable each parser separately
|
||||
*  class attribute to code blocks if there is text after the three backticks like ` ```cpp`
|
||||
*  optional support for latex blocks - it's off by default
|
||||
*  version info to the parser class
|
||||
* ?
|
||||
|
||||
## version 1.1.2 2020-10-04
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# maddy
|
||||
|
||||
[](https://opensource.org/licenses/MIT)
|
||||
[](https://semver.org/)
|
||||
[](https://semver.org/)
|
||||
|
||||
maddy is a C++ Markdown to HTML **header-only** parser library.
|
||||
|
||||
@@ -45,8 +45,8 @@ std::stringstream markdownInput("");
|
||||
std::shared_ptr<maddy::ParserConfig> config = std::make_shared<maddy::ParserConfig>();
|
||||
// config->isEmphasizedParserEnabled = false; // default true - this flag is deprecated
|
||||
// config->isHTMLWrappedInParagraph = false; // default true - this flag is deprecated
|
||||
config->enabledParsers &= ~maddy::types::EMPHASIZED_PARSER;
|
||||
config->enabledParsers |= maddy::types::HTML_PARSER;
|
||||
config->enabledParsers &= ~maddy::types::EMPHASIZED_PARSER; // equivalent to !isEmphasizedParserEnabled
|
||||
config->enabledParsers |= maddy::types::HTML_PARSER; // equivalent to !isHTMLWrappedInParagraph
|
||||
|
||||
std::shared_ptr<maddy::Parser> parser = std::make_shared<maddy::Parser>(config);
|
||||
std::string htmlOutput = parser->Parse(markdownInput);
|
||||
@@ -77,7 +77,6 @@ make test # or run the executable in ../build/MaddyTests
|
||||
There are different possibilities:
|
||||
|
||||
* [Create a GitHub issue](https://github.com/progsource/maddy/issues/new)
|
||||
* Create a pull request with an own branch (don't forget to put yourself in the
|
||||
AUTHORS file)
|
||||
* Create a pull request with an own branch
|
||||
|
||||
Please also read [CONTRIBUTING.md](CONTRIBUTING.md).
|
||||
|
||||
@@ -51,6 +51,14 @@ namespace maddy {
|
||||
class Parser
|
||||
{
|
||||
public:
|
||||
/**
|
||||
* Version info
|
||||
*
|
||||
* 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.0"; return v; }
|
||||
|
||||
/**
|
||||
* ctor
|
||||
*
|
||||
|
||||
Reference in New Issue
Block a user