/inkdrop-github-project-todo-md

Inkdrop: Sync between GitHub Project Board <-> Markdown Todo text.

Primary LanguageJavaScriptMIT LicenseMIT

sync-github-project-todo-md for Inkdrop

Sync between GitHub Project Board <-> Markdown Todo text.

Dec-24-2020.00-21-11.mp4

Installation

Install with ipm

ipm install sync-github-project-todo-md

Configuration

Set GitHub Personal Token that you can get from https://github.com/settings/tokens/new

  1. Preferences > Plugins > sync-github-project-todo-md > github_token

Usage

Prepare: Your note should include a GitHub Project URL like https://github.com/azu/github-project-todo-md/projects/1 at first line.

Project: https://github.com/azu/github-project-todo-md/projects/1

Pull from GitHub Project

  1. Click "Plugins" > "github-project-todo-md" > "Pull from GitHub Project"

This plugin adds GitHub Project as Markdown text into your active note.

Example result:

Project: https://github.com/azu/github-project-todo-md/projects/1

to be

Project: https://github.com/azu/github-project-todo-md/projects/1

## To do

- [ ] [TODO ISSUE](https://github.com/azu/github-project-todo-md/issues/4)


## In progress

- [ ] [PROGRESS ISSUE](https://github.com/azu/github-project-todo-md/issues/3)


## Done

- [x] [DONE ISSUE](https://github.com/azu/github-project-todo-md/issues/5)

Push to GitHub Project

  1. Click "Plugins" > "github-project-todo-md" > "Push to GitHub Project"

Sync your note task checked to each GitHub Issues and Pull Requests.

If your note is following, This plugin open issues/4 and issues/3, also close issues/5.

These issues and pull requests should be included in projects/1.

Project: https://github.com/azu/github-project-todo-md/projects/1

## To do

- [ ] [TODO ISSUE](https://github.com/azu/github-project-todo-md/issues/4)


## In progress

- [ ] [PROGRESS ISSUE](https://github.com/azu/github-project-todo-md/issues/3)


## Done

- [x] [DONE ISSUE](https://github.com/azu/github-project-todo-md/issues/5)

Related

Tests

  • Write How to Tests

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

License

MIT