Skip to content

Commit dcc191f

Browse files
committed
Document flexmark formatter
1 parent 18582f6 commit dcc191f

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

README.md

+2
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ lib('kotlin.KtLintStep') +'{{yes}} | {{yes}}
6464
lib('kotlin.KtfmtStep') +'{{yes}} | {{yes}} | {{no}} | {{no}} |',
6565
lib('kotlin.DiktatStep') +'{{yes}} | {{yes}} | {{no}} | {{no}} |',
6666
lib('markdown.FreshMarkStep') +'{{yes}} | {{no}} | {{no}} | {{no}} |',
67+
lib('markdown.FlexmarkStep') +'{{no}} | {{yes}} | {{no}} | {{no}} |',
6768
lib('npm.PrettierFormatterStep') +'{{yes}} | {{yes}} | {{no}} | {{no}} |',
6869
lib('npm.TsFmtFormatterStep') +'{{yes}} | {{yes}} | {{no}} | {{no}} |',
6970
lib('pom.SortPomStepStep') +'{{no}} | {{yes}} | {{no}} | {{no}} |',
@@ -103,6 +104,7 @@ extra('wtp.EclipseWtpFormatterStep') +'{{yes}} | {{yes}}
103104
| [`kotlin.KtfmtStep`](lib/src/main/java/com/diffplug/spotless/kotlin/KtfmtStep.java) | :+1: | :+1: | :white_large_square: | :white_large_square: |
104105
| [`kotlin.DiktatStep`](lib/src/main/java/com/diffplug/spotless/kotlin/DiktatStep.java) | :+1: | :+1: | :white_large_square: | :white_large_square: |
105106
| [`markdown.FreshMarkStep`](lib/src/main/java/com/diffplug/spotless/markdown/FreshMarkStep.java) | :+1: | :white_large_square: | :white_large_square: | :white_large_square: |
107+
| [`markdown.FlexmarkStep`](lib/src/main/java/com/diffplug/spotless/markdown/FlexmarkStep.java) | :white_large_square: | :+1: | :white_large_square: | :white_large_square: |
106108
| [`npm.PrettierFormatterStep`](lib/src/main/java/com/diffplug/spotless/npm/PrettierFormatterStep.java) | :+1: | :+1: | :white_large_square: | :white_large_square: |
107109
| [`npm.TsFmtFormatterStep`](lib/src/main/java/com/diffplug/spotless/npm/TsFmtFormatterStep.java) | :+1: | :+1: | :white_large_square: | :white_large_square: |
108110
| [`pom.SortPomStepStep`](lib/src/main/java/com/diffplug/spotless/pom/SortPomStepStep.java) | :white_large_square: | :+1: | :white_large_square: | :white_large_square: |

plugin-maven/README.md

+25
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ user@machine repo % mvn spotless:check
5656
- [Antlr4](#antlr4) ([antlr4formatter](#antlr4formatter))
5757
- [Sql](#sql) ([dbeaver](#dbeaver))
5858
- [Maven Pom](#maven-pom) ([sortPom](#sortpom))
59+
- [Markdown](#markdown) ([flexmark](#flexmark))
5960
- [Typescript](#typescript) ([tsfmt](#tsfmt), [prettier](#prettier))
6061
- Multiple languages
6162
- [Prettier](#prettier) ([plugins](#prettier-plugins), [npm detection](#npm-detection), [`.npmrc` detection](#npmrc-detection))
@@ -585,6 +586,30 @@ All configuration settings are optional, they are described in detail [here](htt
585586
</sortPom>
586587
```
587588

589+
## Markdown
590+
591+
[code](https://github.com/diffplug/spotless/blob/main/plugin-maven/src/main/java/com/diffplug/spotless/maven/markdown/Markdown.java). [available steps](https://github.com/diffplug/spotless/tree/main/plugin-maven/src/main/java/com/diffplug/spotless/maven/markdown).
592+
593+
```xml
594+
<configuration>
595+
<markdown>
596+
<!-- These are the defaults, you can override if you want -->
597+
<includes>
598+
<include>*.md</include>
599+
<include>**/*.md</include>
600+
</includes>
601+
602+
<flexmark/> <!-- has its own section below -->
603+
</markdown>
604+
</configuration>
605+
```
606+
607+
### Flexmark
608+
609+
[homepage](https://github.com/vsch/flexmark-java). [code](https://github.com/diffplug/spotless/blob/main/plugin-maven/src/main/java/com/diffplug/spotless/maven/markdown/Flexmark.java).
610+
611+
None of the available options can be configured yet. Currently it uses only the default options together with `COMMONMARK` as `FORMATTER_EMULATION_PROFILE`. All options are described in detail [here](https://github.com/vsch/flexmark-java/wiki/Markdown-Formatter#options).
612+
588613
<a name="applying-to-typescript-source"></a>
589614

590615
## Typescript

0 commit comments

Comments
 (0)