You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Generating URL's for the buttons above is tricky. Once they're generated, it's hard to keep them up-to-date as new versions are released. FreshMark solves the "Markdown with variables" problem by embedding tiny JavaScript SCRIPTs into the comments of your Markdown, which statically generate the rest of the document. By running these SCRIPTs as part of your build script, your project's documentation will always stay up-to-date.
26
-
27
-
Here is what the code looks like for the shields at the top of this document:
... (the results from the last time that FreshMark was run)
39
-
<!---freshmark /shields -->
40
-
```
41
-
42
-
In addition to generating Markdown from scratch, FreshMark can also modify existing Markdown. This ensures that any inline documentation links stay fresh.
To run FreshMark on some text, call [FreshMark.compile()](https://diffplug.github.io/freshmark/javadoc/1.0/com/diffplug/freshmark/FreshMark.html)
49
-
<!---freshmark /javadoc -->
50
-
```
51
-
52
-
## How it works
53
-
54
-
FreshMark has three pieces, `SECTION`, `SCRIPT`, and `BODY`. They are parsed as shown below:
55
-
56
-
```javascript
57
-
<!---freshmark SECTION (identifier)
58
-
SCRIPT (javascript)
59
-
-->
60
-
BODY (markdown)
61
-
<!---freshmark /SECTION-->
62
-
```
63
-
64
-
When `SCRIPT` is run, there are two magic variables:
65
-
66
-
* `input` - This is everything inside of BODY (guaranteed to have only unix newlines at runtime)
67
-
* `output` - The script must assign to this variable. FreshMark will generate a new string where the `BODY` section has been replaced with this value.
68
26
69
-
Only four functions are provided:
70
-
71
-
* `link(text, url)` - returns a markdown link
72
-
* `image(altText, url)` - returns a markdown image
73
-
* `shield(altText, subject, status, color)` - returns a markdown image generated by [shields.io](http://shields.io/).
74
-
* `prefixDelimReplace(input, prefix, delimiter, replace)` - updates URLs which contain version numbers.
75
-
* example: for parameters `prefix='http://website/', delimiter='/', replace='2.0'`
76
-
* input `[entry point](http://website/1.2/docs/entryPoint)` would be transformed into `[entry point](http://website/2.0/docs/entryPoint)`
77
-
78
-
It's full ECMAScript 5.1, so you can define any other functions you like, but these should be all you need.
79
-
80
-
When you run FreshMark, you can supply it with a map of key-value pairs using the command line or via a properties file. If you're running FreshMark from a build system plugin such as Gradle, then all of your project's metadata will automatically be supplied. These key-value pairs are used in the following way:
81
-
82
-
* Before `SCRIPT` is executed, any `{{key}}` templates will be substituted with their corresponding value.
83
-
* When `SCRIPT` is executed, all of these key-value pairs are available as variables.
84
-
85
-
## How to run it
86
-
87
-
At the moment, you can run FreshMark using [Gradle](#gradle), the [console](#console), or the [Java API](#java-api directly. If you need a different way to run FreshMark, build it and submit a PR! We'd be happy to help [in Gitter](https://gitter.im/diffplug/freshmark).
88
-
89
-
### Gradle
90
-
91
-
Integration with Gradle is provided through the [Spotless](https://github.com/diffplug/spotless) plugin. Spotless can also enforce lots of style rules as well (tab vs whitespace, Java import ordering, etc), but it's completely a-la-carte. To just apply FreshMark to all of the markdown in your project (and nothing else), simply add this to your `build.gradle`:
92
-
93
-
```groovy
94
-
plugins {
95
-
id 'com.diffplug.gradle.spotless' version '1.4.0'
96
-
}
97
-
98
-
spotless {
99
-
freshmark '**/*.md'
100
-
}
101
-
```
102
-
103
-
See the [spotless docs] for more details.
104
-
105
-
### CLI
106
-
107
-
This repo is a command line application. Just run `freshmark.bat` (Windows) or `freshmark` (Linux and Mac) to run it.
108
-
109
-
```
110
-
freshmark --help
111
-
112
-
113
-
```
114
-
115
-
### Java API
116
-
117
-
There's just one class that really matters. If you want to add more functions, change which variables are there, make the behavior depend on the section name, etc, just take a peek at [FreshMark.java](src/main/java/com/diffplug/freshmark/FreshMark.java).
27
+
<!---freshmark /javadoc -->
118
28
119
29
## Acknowledgements
120
30
* Scripts run by [JScriptBox](https://github.com/diffplug/jscriptbox).
0 commit comments