com.github.codemonstur:slate4j

A Java maven plugin for compiling slate documentation.

License	MIT License
GroupId	com.github.codemonstur
ArtifactId	slate4j
Last Version	0.2.0
Release Date	Jan 17, 2020
Type	maven-plugin
Description	com.github.codemonstur:slate4j A Java maven plugin for compiling slate documentation.
Project URL	https://github.com/codemonstur/slate4j
Source Code Management	https://github.com/codemonstur/slate4j

Download slate4j

Filename	Size
slate4j-0.2.0.pom
slate4j-0.2.0.jar	63 KB
slate4j-0.2.0-sources.jar	48 KB
slate4j-0.2.0-javadoc.jar	417 KB

How to add to project

Apache Maven

<plugin>
    <groupId>com.github.codemonstur</groupId>
    <artifactId>slate4j</artifactId>
    <version>0.2.0</version>
</plugin>

Dependencies

compile (5)

Group / Artifact	Type	Version
com.vladsch.flexmark : flexmark-all	jar	0.50.46
org.jsoup : jsoup	jar	1.12.1
com.google.code.gson : gson	jar	2.8.6
org.apache.maven : maven-plugin-api	jar	3.0
org.apache.maven : maven-project	jar	2.2.1

provided (1)

Group / Artifact	Type	Version
org.apache.maven.plugin-tools : maven-plugin-annotations	jar	3.5

test (1)

Group / Artifact	Type	Version
junit : junit	jar	4.12

Project Modules

There are no modules declared in this project.

Slate4j

Produces an HTML file that looks similar and has the same functionality as slate. The output isn't exactly the same but is close enough to work with.

These are the known changes and issues:

• The search icon isn't there
• The syntax highlighting works with a different library and in a different way
• Images are inlined
• It is not possible to override all the code the way you can in slate

The big benefit of this code is that it is nothing more than a self contained maven plugin. No need to install ruby or node or mess around with docker trying to get the original slate to work.

Configuration

Add this to the pom:

<plugin>
  <groupId>com.github.codemonstur</groupId>
  <artifactId>slate4j</artifactId>
  <version>0.1.0</version>
  <executions>
    <execution>
      <phase>generate-resources</phase>
      <goals><goal>compile</goal></goals>
    </execution>
  </executions>
</plugin>

Slate4j will read slate markdown from src/main/docs/index.html.md. And generate output in target/classes/docs/index.html.

Versions

Version
0.2.0 Jan 17, 2020
0.1.0 Jan 17, 2020