代码拉取完成，页面将自动刷新
Plugin creates static HTML pages with Maven and Markdown. Uses flexmark-java Markdown processor. The code is Open Source and under MIT license.
Plugin Information:
![dependabot[bot]-](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAUCAYAAACNiR0NAAAAAXNSR0IArs4c6QAAAARzQklUCAgICHwIZIgAAAC7SURBVDhPY5wdue0/AxUB46iBFIfmaBgigpCRiZEheYkHWODv738MX958Z7h34jnD+fV3Gf79+YczrHGGIcjAhPluDPPjdzKwsDMzCMrwMFjGaTG8uvOB4cTi65QZCNPNK8bJENRuw7AweTd1DASZkrTInWFJ5l6GX1//YDWUKC/DXSgKdGEHFVzIzMYEDENeBstYTYbXdz8ynFhCZhjCYvnf3/8MX15DYvncujvkxTK5eXA065Ebcgh9AAvTekkevapEAAAAAElFTkSuQmCC){kind=small}
<plugin>
<groupId>com.ruleoftech</groupId>
<artifactId>markdown-page-generator-plugin</artifactId>
<version>2.4.0</version>
</plugin>
Artifacts:
You can configure the input and output directories, which files to copy and which pegdown options are used. You can also include custom header and footer and general title.
Default configuration which can be overridden:
inputDirectory: ${project.basedir}/src/main/resources/markdown/outputDirectory: ${project.build.directory}/html/Configuration options:
applyFiltering: apply variables substitution if true. Default false.
Example:
header.html:
<!DOCTYPE html>
<html lang="${lang}">
<head>
</head>
page.md:
# Title
{lang=en}
will output in page.html:
<!DOCTYPE html>
<html lang="en">
<head>
</head>
<h1>Title</h1>
headerHtmlFile: Location of header HTML file as String,
${project.basedir}/src/main/resources/markdown/html/header.html
Example:
<!DOCTYPE html>
<html lang="en">
<head>
<title>titleToken</title>
<meta charset="utf-8" />
<link rel="stylesheet" href="##SITE_BASE##/css/default.css">
</head>
Note: ##SITE_BASE## will be translated to a relative path from the markdown file's
directory to base directory. This is not necessary if recursiveInput configuration is
false.
footerHtmlFile : Location of header HTML file as String,
${project.basedir}/src/main/resources/markdown/html/footer.html
Example:
<footer>
</footer>
</html>
copyDirectories: Comma separated list of directories to copy to output directory, like:
`css,js,images,folder*/images,**images'
defaultTitle: If set the titleToken is replaced in every page. Otherwise the first h1 is
used.
recursiveInput: Process also inputDirectory's sub directories if option true. Default
false.
transformRelativeMarkdownLinks: Transform relative url suffix from .md to .html if
option true. Default false.
attributes: defines a list of attributes by Node class to apply to HTML results. Each
attribute has the syntax:
NodeClass|attributeName1=attributeValue1|attributeName2=attributeValue2 will add
attributeName1 and attributeName2 to element node NodeClass
for table, block quote and ordered list item class customization:
<attributes>
<attribute>TableBlock|class=table table-striped table-bordered</attribute>
<attribute>BlockQuote|class=red</attribute>
<attribute>OrderedListItem|style="color:red;"</attribute>
</attributes>
Core Nodes:
AutoLink
BlockQuote
BulletList
BulletListItem
Code
Emphasis
FencedCodeBlock
Heading
Image
ImageRef
IndentedCodeBlock
Link
LinkRef
MailLink
OrderedList
OrderedList
OrderedListItem
Strikethrough
StrongEmphasis
TableBlock
TableBody
TableCaption
TableCell
TableHead
TableRow
ThematicBreak
pegdownExtensions: Comma separated list of constants as specified in
com.vladsch.flexmark.profiles.pegdown.Extensions. The default is TABLES.
SMARTS: Beautifies ... . . ., -- and --- to …, …, – and — respectively.
QUOTES: Beautifies single quotes ', ", << and >> to ‘ ’ ‛, “ ” ‟, «
and »
SMARTYPANTS: Convenience extension enabling both, SMARTS and QUOTES, at once.
ABBREVIATIONS: Abbreviations in the way of PHP Markdown Extra.
ANCHORLINKS: Generate anchor links for headers by taking the first range of alphanumerics
and spaces.
HARDWRAPS: Alternative handling of newlines, see Github-flavoured-Markdown
AUTOLINKS: Plain, undelimited autolinks the way Github-flavoured-Markdown implements
them.
TABLES: Tables similar to MultiMarkdown (which is in turn like the
PHP Markdown Extra: tables tables, but with colspan support).
DEFINITIONS: Definition lists in the way of PHP Markdown Extra: definition list.
FENCED_CODE_BLOCKS: Fenced Code Blocks in the way of PHP Markdown Extra: fenced code or
Github-flavoured-Markdown.
SUPPRESS_HTML_BLOCKS: Suppresses the output of HTML blocks.
SUPPRESS_INLINE_HTML: Suppresses the output of inline HTML elements.
WIKILINKS: Support [[Wiki-style links]] with a customizable URL rendering logic.
STRIKETHROUGH: Support ~~strikethroughs~~ as supported in Pandoc and
Github-flavoured-Markdown.
ATXHEADERSPACE: Require a space between the # and the header title text, as per
Github-flavoured-Markdown. Frees up # without a space to be just plain text.
FORCELISTITEMPARA: Wrap a list item or definition term in <p> tags if it contains more
than a simple paragraph.
RELAXEDHRULES: allow horizontal rules without a blank line following them.
TASKLISTITEMS: parses bullet lists of the form * [ ], * [x] and * [X] to create
Github-flavoured-Markdown task list items.
EXTANCHORLINKS: Generate anchor links for headers using complete contents of the header.
-, multiple dashes trimmed to one.<h1><a name="header"></a>header</h1>EXTANCHORLINKS_WRAP: used in conjunction with above to create an anchor that wraps header
content: <h1><a name="header">header</a></h1>
TOC: used to enable table of contents extension [TOC] The TOC tag has the following
format: [TOC style]. style consists of space separated list of options:
levels=levelList where level list is a comma separated list of levels or ranges. Default
is to include heading levels 2 and 3. Examples:
levels=4 include levels 2, 3 and 4levels=2-4 include levels 2, 3 and 4. same as levels=4levels=2-4,5 include levels 2, 3, 4 and 5levels=1,3 include levels 1 and 3text to only include the text of the headingformatted to include text and inline formattingbullet to use a bullet list for the TOC itemsnumbered to use a numbered list for TOC itemshierarchy: hierarchical list of headingsflat: flat list of headingsreversed: flat reversed list of headingsincreasing: flat, alphabetically increasing by heading textdecreasing: flat, alphabetically decreasing by heading textMULTI_LINE_IMAGE_URLS: enables parsing of image urls spanning more than one line the
format is strict  or "title") must be the first non-indented segment on the line. Everything
in between is sucked up as part of the URL except for blank lines.
RELAXED_STRONG_EMPHASIS_RULES: allow Strong/Emphasis marks to start when not preceded by
alphanumeric for _ and as long as not surrounded by spaces for * instead of only when
preceded by spaces.
FOOTNOTES: Support MultiMarkdown style footnotes: [^n] for footnote reference and [^n]: Footnote text for footnotes. Where n is one or more digit, letter, -, _ or ..
Footnotes will be put at the bottom of the page, sequentially numbered in order of
appearance of the footnote reference. Footnotes that are not referenced will NOT be included
in the HTML output.
This paragraph has a footnote[^1] and another footnote[^two].
This one has more but out of sequence[^4] and[^eight].
[^two]: Footnote 2 with a bit more text
and another continuation line
[^1]: Footnote 1
[^3]: Unused footnote, it will not be added to the end of the page.
[^4]: Out of sequence footnote
[^eight]: Have one that is used.
will generate:
<p>This paragraph has a footnote<sup id="fnref-1"><a href="#fn-1" class="footnote-ref">1</a></sup> and another footnote<sup id="fnref-2"><a href="#fn-2" class="footnote-ref">2</a></sup>.</p>
<p>This one has more but out of sequence<sup id="fnref-3"><a href="#fn-3" class="footnote-ref">3</a></sup> and<sup id="fnref-4"><a href="#fn-4" class="footnote-ref">4</a></sup>. </p>
<div class="footnotes">
<hr/>
<ol>
<li id="fn-1"><p>Footnote 1<a href="#fnref-1" class="footnote-backref">↩</a></p></li>
<li id="fn-2"><p>Footnote 2 with a bit more text and another continuation line<a href="#fnref-2" class="footnote-backref">↩</a></p></li>
<li id="fn-3"><p>Out of sequence footnote<a href="#fnref-3" class="footnote-backref">↩</a></p></li>
<li id="fn-4"><p>Have one that is used.<a href="#fnref-4" class="footnote-backref">↩</a></p></li>
</ol>
</div>
to look like this:
SUBSCRIPT: subscript extension ~subscript~
SUPERSCRIPT: superscript extension ^superscript^
INSERTED: inserted or underlined extension ++inserted++
removeMarkdownHeaders: Remove headers on top of markdown files if exists.
---
Header information
title: Title
...
---
Markdown Content
...
inputFileExtensions: Comma-separated input file extensions (auto trim included), default:
md
Example
<configuration>
<inputFileExtensions> md, markdown </inputFileExtensions>
</configuration>
inputEncoding: Charset-Name used for reading the md-input, default:
${project.build.sourceEncoding} or Default-Charset
outputEncoding: Charset-Name used for writing the html-output, default:
${project.build.sourceEncoding} or Default-Charset
The output will be:
target/html/name_of_file.htmlAdd the plugin to the pom file in your project:
<build>
<plugins>
<plugin>
<groupId>com.ruleoftech</groupId>
<artifactId>markdown-page-generator-plugin</artifactId>
<version>2.1.0</version>
<executions>
<execution>
<phase>process-resources</phase>
<goals>
<goal>generate</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
Or with custom header and footer:
<plugin>
<groupId>com.ruleoftech</groupId>
<artifactId>markdown-page-generator-plugin</artifactId>
<version>2.1.0</version>
<executions>
<execution>
<phase>process-resources</phase>
<goals>
<goal>generate</goal>
</goals>
</execution>
</executions>
<configuration>
<headerHtmlFile>${project.basedir}/src/main/resources/markdown/html/header.html</headerHtmlFile>
<footerHtmlFile>${project.basedir}/src/main/resources/markdown/html/footer.html</footerHtmlFile>
<copyDirectories>css,js</copyDirectories>
</configuration>
</plugin>
You can also specify the Pegdown extensions:
<plugin>
<groupId>com.ruleoftech</groupId>
<artifactId>markdown-page-generator-plugin</artifactId>
<version>2.1.0</version>
<executions>
<execution>
<phase>process-resources</phase>
<goals>
<goal>generate</goal>
</goals>
</execution>
</executions>
<configuration>
<pegdownExtensions>TABLES,FENCED_CODE_BLOCKS,AUTOLINKS</pegdownExtensions>
</configuration>
</plugin>
Input- and Output-Encoding can be specified by:
<plugin>
<groupId>com.ruleoftech</groupId>
<artifactId>markdown-page-generator-plugin</artifactId>
<version>2.1.0</version>
<executions>
<execution>
<phase>process-resources</phase>
<goals>
<goal>generate</goal>
</goals>
</execution>
</executions>
<configuration>
<inputDirectory>${basedir}/src/test/resources/encoding-project/src/main/resources/markdown</inputDirectory>
<outputDirectory>${basedir}/target/test-harness/encoding-project/html</outputDirectory>
<inputEncoding>UTF-8</inputEncoding>
<outputEncoding>ISO-8859-15</outputEncoding>
</configuration>
</plugin>
此处可能存在不合适展示的内容，页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容，可点击提交进行申诉，我们将尽快为您处理。
马建仓 AI 助手