mdx can run the shell scripts in your markdown files.
- chmod +x
chmod +x mdx- Move it to a directory on your PATH
Let's say we have a helloworld.md :
This example prints "hello"
```shell
echo "hello"
```
This example prints "world"
```shell
echo "world"
```
This example exits with an error!
So sad!
```shell
echoooo "typooo"
```You can "run" this markdown file:
mdx helloworld.mdThis command will run all the shell scripts in the helloworld.md.
The following message will be printed out:
hello
world
: line 3: echoooo: command not foundLet's say we have a quickstart.md :
## Start Layotto
Download Layotto:
```shell
git clone https://github.com/mosn/layotto.git
```
Change directory:
```shell
cd layotto/cmd/layotto
```
Build:
```shell @if.not.exist layotto
go build
```
Run Layotto:
```shell @background
./layotto start -c ../../configs/config_in_memory.json
```
## Run Demo
```shell
cd ${project_path}/demo/sequencer/common/
go build -o client
./client -s "sequencer_demo"
```
And you will see:
```bash
runtime client initializing for: 127.0.0.1:34904
Try to get next id.Key:key666
Next id:next_id:1
Next id:next_id:2
Next id:next_id:3
Next id:next_id:4
Next id:next_id:5
Next id:next_id:6
Next id:next_id:7
Next id:next_id:8
Next id:next_id:9
Next id:next_id:10
Demo success!
```You can "run" this file and see what will happen:
mdx quickstart.mdThis tool run the script in
```shell
```
blocks.
It also provides you with some "annotations" which make it easier to write a "runnable" markdown file, including:
If you want to run a command as a background job, you can add an @background to the shell tag.
For example:
Run Layotto:
```shell @background
./layotto start -c ../../configs/config_in_memory.json
```It will be compiled to:
nohup ./layotto start -c ../../configs/config_in_memory.json &
sleep 2s
The @background command will sleep 2s by default. You can customize the sleep time:
Run Layotto:
```shell @background.sleep 5s
./layotto start -c ../../configs/config_in_memory.json
```It will be compiled to:
nohup ./layotto start -c ../../configs/config_in_memory.json &
sleep 5s
In some scenarios, you want to "compile the project if there is no compiled binary file".
Then you can use @if.not.exist xxx. The script is only executed when the file xxx does NOT EXIST.
For example:
Build:
```shell @if.not.exist layotto
go build
```@if.exist xxx means the script is only executed when the file xxx EXISTS.
The variable ${project_path} is set to the root path where mdx is run. If you have switched directories many times and want to go back to the beginning, you can:
```shell
cd ${project_path}
```You can use @cd to change directory before running the script. For example:
```shell
cd aaa/ccc
```
go back to aaa/bbb:
```shell @cd ${project_path}
cd aaa/bbb
```By default, any error will stop the execution.
If you want to tolerant errors when running some script, you can add a @catch.
For example, see catch.md:
Here is a typo. We will catch and ignore the error:
```shell @catch
echoo "xxx"
```
Here is the correct one:
```shell
echo "xxx"
```
Here is another command with typo, but we won't catch the error this time, and it will interrupt the execution.
```shell
echoo "This command will interrupt the execution"
```
Here is another correct command.It won't be executed because the above error have already interrupted the execution.
```shell
echo "This command won't be executed"
```Run this file and see what will happen:
mdx catch.mdIf you don't want to run some script blocks, you can use some other "tag" for it. For example:
And you will see:
```bash
runtime client initializing for: 127.0.0.1:34904
Try to get next id.Key:key666
Next id:next_id:1
Next id:next_id:2
Next id:next_id:3
Next id:next_id:4
Next id:next_id:5
Next id:next_id:6
Next id:next_id:7
Next id:next_id:8
Next id:next_id:9
Next id:next_id:10
Demo success!
```The script in bash blocks will not be run.
By default, this tool ONLY run the script in
```shell
blocks.
Hidden script
You can add some hidden script, which can not be seen by the markdown readers but will be run by this tool. For example, check the hidden.md :
```shell
echo "Hello!"
```
<!--
```shell
echo "This is a hidden script!"
```
-->
```shell
echo "Bye!"
```You can run it and see what happened:
mdx hidden.mdmdx is mdsh with some pre-defined "annotations" which make it easier to write a "runnable" markdown file. So, a lot of shell script in this repo is copied from mdsh ,and you can check mdsh for more details.