template.markdown.README.md Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of substitution-doc Show documentation

This module generates a documentation for the https://github.com/credibledoc/credible-doc/tree/master/substitution projects. See description on the https://github.com/credibledoc/credible-doc/tree/master/substitution/substitution-doc page.

There is a newer version: 1.0.8

Show newest version

# Module substitution-doc
This module generates a documentation for the
[placeholder-substitution](../README.md) module. This document is also generated
by this `substitution-doc` module.

## Usage
Please open a command line and try it yourself.

Clone this project from Github

    git clone https://github.com/credibledoc/placeholder-substitution.git

Change directory

    cd placeholder-substitution
    
Build by Maven
    
    mvn clean install

Change directory
    
    cd substitution-doc
    
Launch the application

    java -jar target/&&beginPlaceholder {
                  "className": "com.credibledoc.substitution.content.generator.jar.LocalJarNameContentGenerator",
                  "description": "Current name of the substitution-doc-X.X.X.jar.",
                  "parameters": {
                      "targetDirectoryRelativePath": "target",
                      "jarNamePrefix": "substitution-doc-"
                  }
              } &&endPlaceholder

As a result, the `target/generated/markdown` folder with new folders and files
is generated.

Please inspect these generated files in the `substitution-doc/target/generated/markdown` folder.
These generated files is the documentation you are currently reading. You can use
this approach for generation of documentation for your own projects.

## Templates used for generation of this documentation
This documentation is generated from these templates:

&&beginPlaceholder {
    "className": "com.credibledoc.substitution.content.generator.resource.ResourcesListMarkdownGenerator",
    "description": "List of resources from classpath of the substitution-doc application.",
    "parameters": {"endsWith": ".md"}
} &&endPlaceholder

As you can notice, this generated document and its template have common parts,
and this diff shows different parts. These different parts are placeholders and
the content generated from these placeholders.
![Image of differences between template and generated files](doc/img/diffBetweenTemplateAndGeneratedFiles.png)

## Examples of PlantUML diagrams

The [diagrams.md](doc/diagrams.md) page shows some examples of PlantUML diagrams
generated from log files.