Socket
Socket
Sign inDemoInstall

gitbook-plugin-todos-list

Package Overview
Dependencies
14
Maintainers
1
Versions
3
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    gitbook-plugin-todos-list

A ToDo plugin for GitBook


Version published
Maintainers
1
Install size
2.51 MB
Created

Readme

Source

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:

{
    "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.

FAQs

Last updated on 30 Jun 2017

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc