# gitbook-plugin-todos-list

> A ToDo plugin for GitBook

Latest version **0.2.0** (published 2017-06-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install gitbook-plugin-todos-list
pnpm add gitbook-plugin-todos-list
yarn add gitbook-plugin-todos-list
bun add gitbook-plugin-todos-list
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2017-06-30 |
| First published | 2017-06-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Maintainers | m0n0l0c0 |

## Links

- npm: https://www.npmjs.com/package/gitbook-plugin-todos-list
- Repository: https://github.com/m0n0l0c0/gitbook-plugin-todos-list
- Issues: https://github.com/m0n0l0c0/gitbook-plugin-todos-list/issues
- npm.io page: https://npm.io/package/gitbook-plugin-todos-list

## Dependencies (1)

- [cheerio](https://npm.io/package/cheerio.md) ^1.0.0-rc.1

## Recent versions

- 0.2.0 (latest) — 2017-06-30
- 0.1.0 — 2017-06-23
- 0.0.1 — 2017-06-21

## README

Gitbook Plugin Todos List
=============

A gitbook plugin to automatically create a list of todos.

### Install

Add this to your `book.json`, then run `gitbook install`:

```json
{
    "plugins": ["todos-list"]
}
```

### Setup

No configuration is needed.

### Usage

When you want to create a todo called `Buy apples` you can do it like this:

```
{{ "Buy apples" | todo }}
```

Then, to obtain a list of todos:

```
{% todos %} {% endtodos %}
```

To mark a todo as done:

```
{{ "Buy apples" | todo(true) }}
```

Then it will appear as ~~ToDo:= Buy apples~~ and checked in the list of todos

I think is better to keep this list in a Todos.md file or something like that, but is up to you.

### Notes

The key `todo` here is also parsed as `ToDo` and `TODO`, so you can write it as you want, the same applies to `todos`.

---
_Source: https://npm.io/package/gitbook-plugin-todos-list · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._