New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Markdownのほうが書きやすい/読みやすいと思います！ #4

Open

ryotan opened this issue Mar 11, 2020 · 0 comments

ryotan commented Mar 11, 2020

例えば、こういうフォーマットで書けるようになっていると、ドキュメントとしても読みやすいんじゃないかと思います。

# ドキュメントタイトル

## タスク1

タスク一覧で表示される、一行の説明文。

複数行の説明文。
複数行の説明文。

```bash
command1 to execute
```

### タスク1-1


```bash
command2 to execute
```

実行した結果はこんな感じになると使いやすそうだと思います！

waddle タスク1
# => command1 to execute
# => command2 to execute

waddle タスク2
# => command2 to execute

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment