UNPKG

928 BMarkdownView Raw
1## The simplest way to run your npm type tasks
2
3You write a beautiful & documented Markdown file, we run it for you. And you have a lot of flexibility!
4
5Example **.fscripts.md** file :
6
7````markdown
8# Group 1
9
10## run
11
12```bash
13echo 'start'; sleep 4; echo 'done'
14```
15
16
17## run:s
18
19```bash
20yarn fsr run-s run:one run:two
21```
22
23## run:one
24
25```js
26console.log("ONEEE");
27```
28
29## run:two
30
31```js
32console.log("TWOOOO");
33```
34````
35
36Each section is an `h1` and task is defined using `h2` header and its child contents, the value of `h2` header will be used as task name, its following paragraphs (optional) will be used as task description, and following code block (optional) will be used as task script.
37
38````markdown
39# Start Scripts
40
41Start running in development mode
42
43## start:w:u
44
45Run tasks `start:web` and `start:utils` in parallel.
46
47```bash
48fsr run-s start:web start:utils
49```
50
51````
52
53## Password for encrypted file is test52
54
\No newline at end of file