开源软件名称（OpenSource Name）：

开源软件地址(OpenSource Url)：

开源编程语言(OpenSource Language)：

开源软件介绍(OpenSource Introduction)：

maid

Markdown driven task runner.

Table of Contents

• Install
• What is a maidfile?
  • Run tasks before/after a task
  • Task hooks
• Advanced
  • Code block languages
    • bash/sh
      • Read command line arguments
    • js/javascript
      • Asynchronous task
    • py/python
  • Use a custom maidfile
  • ZSH completion
• Development
  • lint
  • test
  • toc
• Contributing
• Author

Install

You can install Maid globally:

# For npm users
npm i -g maid
# For Yarn users
yarn global add maid

Or if you want to ensure that your teammates are using the same version as you, it's recommended to install Maid locally:

# For npm users
npm i -D maid
# For Yarn users
yarn add maid --dev

PRO TIP: you can use npx or yarn command to run any locally installed executable that is inside node_modules/.bin/, e.g. use yarn maid to run the locally installed maid command.

What is a maidfile?

A maidfile is where you define tasks, in Markdown!