[Maid] Write Tasks in Markdown with Maid

Maid enables you to write your tasks in Markdown. Create a maidfile.md or a README.mdthen add Headers to list out your tasks with codeblocks including the tasks to run. This lesson walks you through creating a few tasks in either a maidfile.md or a README.md and how to execute the tasks from the command line.

 

Install:

npm install maid --save-dev

 

Create a maidfile.md

## hello

```bash
echo "hi"
```

Then run:

npx maid hello

 

-----

A more realworld example can be that we can use maid to run build process

 

Install:

npm i -D parcel

 

复制代码
## build

```bash
npx parcel build index.html
```

## dev

```bash
npx parcel index.html
```
复制代码

 

npx maid build

npx maid dev

 

 

----

 

We can also run another task before or after the build task:

复制代码
## build

Run task `start`.

Run task `end` after.

```bash
npx parcel build index.html
```

## dev

```bash
npx parcel index.html
```

## start

```js
console.log("task start")
```

## end

```js
console.log("task end")
```
复制代码

 

---

 

Add description for the tasks:

复制代码
## build

This build the project

Run task `start`.

Run task `end` after.

```bash
npx parcel build index.html
```

## dev

This is for development

```bash
npx parcel index.html
```

## start

This run before the build

```js
console.log("task start")
```

## end

This run after the build

```js
console.log("task end")
```
复制代码

 

Run: 

npx maid help

 

----

 

Using README.md:

in README file, we just need to add 

<!-- maid-tasks -->

Before the tasks we want to run, and all those tasks should have "###".

复制代码
# DEMOs

    * mdx-deck
    *react-live
    *maid


## Tasks
<!-- maid-tasks -->

### build

This build the project

Run task `start`.

Run task `end` after.

```bash
npx parcel build index.html
```

### dev

This is for development

```bash
npx parcel index.html
```

### start

This run before the build

```js
console.log("task start")
```

### end

This run after the build

```js
console.log("task end")
```
复制代码

 

 

Github

posted @   Zhentiw  阅读(223)  评论(0编辑  收藏  举报
编辑推荐:
· SQL Server 2025 AI相关能力初探
· Linux系列:如何用 C#调用 C方法造成内存泄露
· AI与.NET技术实操系列(二):开始使用ML.NET
· 记一次.NET内存居高不下排查解决与启示
· 探究高空视频全景AR技术的实现原理
阅读排行:
· 阿里最新开源QwQ-32B,效果媲美deepseek-r1满血版,部署成本又又又降低了!
· Manus重磅发布:全球首款通用AI代理技术深度解析与实战指南
· 开源Multi-agent AI智能体框架aevatar.ai,欢迎大家贡献代码
· 被坑几百块钱后,我竟然真的恢复了删除的微信聊天记录!
· AI技术革命,工作效率10个最佳AI工具
历史上的今天:
2017-08-18 [D3] Build an Area Chart with D3 v4
2017-08-18 [Node.js] Node Util Promisify - How to Convert Callback Based APIs to Promise-based
2017-08-18 [Angular] Implement a custom form component by using control value accessor
2016-08-18 [RxJS] ReplaySubject
2016-08-18 [React Fundamentals] Composable Components
点击右上角即可分享
微信分享提示