GithubHelp home page GithubHelp logo

clivan / extended-task-lists Goto Github PK

View Code? Open in Web Editor NEW

This project forked from joeriddles/extended-task-lists

0.0 0.0 0.0 253 KB

Extended Markdown support for task lists.

License: MIT License

JavaScript 5.42% TypeScript 82.03% CSS 12.55%

extended-task-lists's Introduction

Extended Task Lists

image

Features

  • ๐ŸŒŸ Render in-progress and won't do task items with their own UI:
    • in-progress syntax: - [.] In progress
    • won't do syntax: - [~] Won't do
    • Now supports live preview mode (as of release 1.0.4)!
  • ๐ŸŒŸ Generate a top-level TODO file by scanning all tasks lists in markdown files
    • Run using the command "Extended Task Lists: Update TODO"

To use

Extra syntax

Simply add an in-progress or won't do task item:

- [ ] Pending
- [.] In progress 
- [~] Won't do
- [x] Done

Generate TODO.md

Open the command palette (Ctrl/Cmd + P by default) and run the "Extended Task Lists: Generate TODO" command.

The generated filename can be configured in the plugin settings, as well as what task item types are included. By default, done and won't do task items are excluded.

To exclude a markdown file's task items from being included in the generated TODO file, add <!-- exclude TODO --> anywhere in the markdown file. To exclude are markdown files in a folder, add an empty .exclude_todos file in the folder.

Development

To get started, set up your local dev environment by following steps 1โ€“3 in the official Obsidian docs for building a plugin.

Basically, the steps look like this:

mkdir -p extended-task-lists/.obsidian/plugins
cd extended-task-lists/.obsidian/plugins
git clone https://github.com/joeriddles/extended-task-lists.git
npm i
npm run dev

Then open the top-level extended-task-lists/ folder in Obsidian as a new vault, enable community plugins in the settings, and enable the Extended Task Lists plugin.

Remember to run npm run dev while developing or you won't see your changes in Obsidian.

Release

To update the package version:

npm version [major|minor|patch]

To create a release:

git tag x.y.z  # done by `npm version`
git push origin --tags

extended-task-lists's People

Contributors

joeriddles avatar lishid avatar ericaxu avatar edo78 avatar fyears avatar chrisgrieser avatar aidenlx avatar reorx avatar tokuhirom avatar timrogers avatar tfthacker avatar phibr0 avatar taurelas avatar kostapc avatar joethei avatar inouetakuya avatar henrebotha avatar gitmurf avatar clemens-e avatar pozdneev avatar aleksey-rowan avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.