Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Checklist format not consistent with most editors #71

Closed
3 tasks
groovenectar opened this issue Feb 26, 2020 · 4 comments
Closed
3 tasks

Checklist format not consistent with most editors #71

groovenectar opened this issue Feb 26, 2020 · 4 comments

Comments

@groovenectar
Copy link

GitJournal's format:

[ ] Item 1
[ ] Item 2
[ ] Item 3

Common Markdown format:

- [ ] Item 1
- [ ] Item 2
- [ ] Item 3

For example, pasting those two in the GitHub editor results in:

[ ] Item 1
[ ] Item 2
[ ] Item 3

  • Item 1
  • Item 2
  • Item 3

From the GitHub blog: https://github.blog/2014-04-28-task-lists-in-all-markdown-documents/

Also tested in a few desktop Markdown editors. I would like to try working on this unless someone else gets to it first... I might also want to add a detection of whether a document contains only a checklist, and use the checklist view by default (perhaps via setting)

@vHanda
Copy link
Contributor

vHanda commented Feb 28, 2020

Hey. Your proposal sounds great. Please let me know if I can help - you can email me or message me on Telegram (vHanda).

Regarding detecting if the document only contains checkboxes - I was thinking of a simpler solution where we store the editor used with each note (if it isn't the default). What do you think?

@groovenectar
Copy link
Author

Regarding detecting if the document only contains checkboxes - I was thinking of a simpler solution where we store the editor used with each note (if it isn't the default). What do you think?

I think that's a cool idea as well...

---
title: The title of the document
type: Checklist
---

And I wonder if the checklist editor could actually be integrated into the document itself... to where it would become a global option of "enable checklist editor"... so any checklists in the document use the editor, and the other markdown still displays normally.. I almost got fully up and running with a dev environment two nights ago with only a couple kinks.. Talk soon!

@mipro98
Copy link

mipro98 commented Apr 25, 2020

So as far as I understand the checklist-detection to use the right editor is now implemented? But would it be possible to change the syntax the checklists use from

[ ] item

to

- [ ] item 

to make it more compatible with other markdown editors/parsers?

@vHanda
Copy link
Contributor

vHanda commented Apr 25, 2020 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants