Skip to content

Commit 674c3a1

Browse files
committed
update docs
1 parent 529834d commit 674c3a1

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,17 @@
1-
# highlightjs-rascript
1+
# highlightjs-rascript
2+
3+
[highlight.js](https://highlightjs.org/) syntax definition for [RATools](https://github.com/Jamiras/RATools) DSL, RAScript
4+
5+
[![GitHub License](https://img.shields.io/github/license/joshraphael/highlightjs-rascript)](https://github.com/joshraphael/highlightjs-rascript/blob/main/LICENSE)
6+
[![test](https://github.com/joshraphael/highlightjs-rascript/actions/workflows/test.yaml/badge.svg)](https://github.com/joshraphael/highlightjs-rascript/actions/workflows/test.yaml)
7+
[![GitHub Tag](https://img.shields.io/github/v/tag/joshraphael/highlightjs-rascript)](https://github.com/joshraphael/highlightjs-rascript/tags)
8+
[![GitHub repo size](https://img.shields.io/github/repo-size/joshraphael/highlightjs-rascript)](https://github.com/joshraphael/highlightjs-rascript/archive/main.zip)
9+
10+
## Commands:
11+
12+
|Title|Command|Parameters|Description|
13+
|-|-|-|-|
14+
|Test|`make test`|None|Test the rascript highlightjs module|
15+
|Generate|`make gen`|None|Generate the distribution Javascript of the rascript highlightjs pacakge|
16+
|Upgrade rascript-syntax|`make upgrade`|None|Upgrade the rascript-syntax version|
17+
|Run|`make run`|None|Build and start simple http webserver with example RAScript syntax (using auto-detection)|

0 commit comments

Comments
 (0)