Skip to content

marc-bouvier-graveyard/baldir_markdown

Repository files navigation

Baldir-Markdown

Sonarcloud Status Github Action CI Status

Aim : a markdown preprocessor to import content of sources files from markdown file in place.

This can be a building block for making Living documentation on platforms. that does not support asciidoc.

Usages examples:

  • (re)-generate doc with snippets included in azure devops pipeline.
  • check is doc is up to date against current code

./src/main/MyJavaFile.java

public class MyJavaFile {

    public static void main(String[] args){

        System.out.writeln("Hello world");

    }

}

./markdown.md

    This is a markwdown file.


    <sourceListingStart source="./src/main/MyJavaFile.java" from="5" to="5" lang="java"/>
    ```java
            System.out.writeln("Hello world");
    ```
    <sourceListingEnd/>
        System.out.writeln("Hello world");

About

simple in place markdown pre-processor to include code snippets

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published