Skip to content

Commit

Permalink
Merge branch 'release/v5.1.1'
Browse files Browse the repository at this point in the history
  • Loading branch information
manuth committed Jan 6, 2022
2 parents 5b030ae + f756ddf commit 6552783
Show file tree
Hide file tree
Showing 19 changed files with 2,824 additions and 2,204 deletions.
18 changes: 17 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## MarkdownConverter [Unreleased]

[Show differences](https://github.com/manuth/MarkdownConverter/compare/v5.0.1...dev)
[Show differences](https://github.com/manuth/MarkdownConverter/compare/v5.1.1...dev)

## MarkdownConverter v5.1.1
### Added
- Support for including foreign markdown files using the `markdown-it-include` plugin ([#132](https://github.com/manuth/MarkdownConverter/pull/132))
Thanks a ton to [Felix Lehoux](https://github.com/L3houx)
- Support for applying classes to document sections using the `markdown-it-container` plugin ([#132](https://github.com/manuth/MarkdownConverter/pull/132))
Once more thanks to [Felix Lehoux](https://github.com/L3houx)

### Fixed
- Broken anchor creation
- Vulnerabilities in dependencies

### Updated
- All dependencies

[Show differences](https://github.com/manuth/MarkdownConverter/compare/v5.0.1...v5.1.1)

## MarkdownConverter v5.0.1
### Updated
Expand Down
31 changes: 30 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ A markdown-converter for [vscode][vscode]
- [Custom Date-Formats](#custom-date-formats)
- [Headers and Footers](#headers-and-footers)
- [Including Table of Contents](#including-table-of-contents)
- [Including Markdown Fragment Files](#including-markdown-fragment-files)
- [Creating Block-Level Custom Containers](#creating-block-level-custom-containers)
- [Third Party Markdown Extensions](#third-party-markdown-extensions)
- [Assets](#assets)
- [CSS- and JavaScript-Files](#css--and-javascript-files)
Expand Down Expand Up @@ -42,7 +44,7 @@ A markdown-converter for [vscode][vscode]
3. Open up the command pallet (<kbd>Ctrl</kbd>, <kbd>Shift</kbd>+<kbd>P</kbd>) and search one of these commands:
- `Markdown: Convert Document` (`Markdown: Dokument Konvertieren` in German) or `mco` (`mk` in German) for short
- `Markdown: Convert all Documents` (`Markdown: Alle Dokumente konvertieren`) or `mcd` (`madk` in German) for short
- `Markdown: Chain all Documents` (`Markdown: Alle Dokumente verketten`) or `mcad` (`madv` in German) for short
- `Markdown: Chain all Documents` (`Markdown: Alle Dokumente verketten`) or `mcad` (`madv` in German) for short
4. Press enter and wait for the process to finish

Normally, `MarkdownConverter` will refuse to convert files which aren't recognized as markdown-files.
Expand Down Expand Up @@ -191,6 +193,33 @@ Furthermore, the `markdownConverter.Parser.Toc.Levels` allows you to choose whic
}
```

## Including Markdown Fragment Files
It is now possible to fragment the document in multiple sections and to merge them all into one. This way, it's possible to work on separate fragments at the same time without having to bear with conflicts during editing. Add fragments using this syntax:

```md
!!!include(file.md)!!!
```

## Creating Block-Level Custom Containers
MarkdownConverter allows you to apply CSS classes to specific parts of your document.
This feature can be used with the following syntax:

***Markdown file:***
```md
:::class

Text Here

:::
```

***CSS file:***
```css
div.class {
// Custom CSS Here
}
```

## Third Party Markdown Extensions
If you want to use third party markdown-extensions in your documents (such as the [Markdown Preview Mermaid Support], [Markdown Footnote] or [Markdown Emoji]), you might want to install the extensions of your choice and enable the `markdownConverter.Parser.SystemParserEnabled` setting which makes `MarkdownConverter` use VSCode's built-in `markdown-it` parser with all markdown extensions enabled.

Expand Down
Loading

0 comments on commit 6552783

Please sign in to comment.