https://github.com/azu/inkdrop-github-project-todo-md
Inkdrop: Sync between GitHub Project Board <-> Markdown Todo text.
https://github.com/azu/inkdrop-github-project-todo-md
github inkdrop management project task todo
Last synced: 9 months ago
JSON representation
Inkdrop: Sync between GitHub Project Board <-> Markdown Todo text.
- Host: GitHub
- URL: https://github.com/azu/inkdrop-github-project-todo-md
- Owner: azu
- License: mit
- Created: 2020-12-23T15:15:24.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-11-21T05:52:05.000Z (about 4 years ago)
- Last Synced: 2025-03-31T13:04:58.945Z (10 months ago)
- Topics: github, inkdrop, management, project, task, todo
- Language: JavaScript
- Homepage:
- Size: 137 KB
- Stars: 9
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# sync-github-project-todo-md for [Inkdrop](https://www.inkdrop.app/)
Sync between GitHub Project Board <-> Markdown Todo text.
https://user-images.githubusercontent.com/19714/103011870-ffd04580-457d-11eb-9560-d69b057a97e7.mp4
## Installation
Install with [ipm](https://docs.inkdrop.app/manual/extend-inkdrop-with-plugins/)
ipm install sync-github-project-todo-md
## Configuration
Set GitHub Personal Token that you can get from
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.
```markdown
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:
```markdown
Project: https://github.com/azu/github-project-todo-md/projects/1
```
to be
```markdown
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`.
```markdown
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
- [azu/github-project-todo-md: A Tool that sync between GitHub Project Board <-> Todo Markdown text.](https://github.com/azu/github-project-todo-md)
## 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