8000 Wekan markdown guide · Issue #2334 · wekan/wekan · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Wekan markdown guide #2334

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.

Sign up for GitHub

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

Jump to bottom
Closed
shaygover opened this issue Apr 14, 2019 · 11 comments
Closed

Wekan markdown guide #2334

shaygover opened this issue Apr 14, 2019 · 11 comments

Comments

@shaygover
Copy link

Hi,

Is there a markdown guide for wekan? As I understand, there are a lot of flavors out there. Which one does Wekan use?

Thanks
@xet7
Copy link
Member
xet7 commented Apr 17, 2019

@shaygover

Wekan uses https://github.com/perak/markdown

Please add directly new wiki page about markdown syntax to to https://github.com/wekan/wekan/wiki and add it to wiki menu near features link. Then close this issue. Thanks!

@shaygover
Copy link
Author

Which means that the github guide is also relevant, right?
https://guides.github.com/features/mastering-markdown/

@shaygover
Copy link
Author

@xet7 Added https://github.com/wekan/wekan/wiki/Wekan-Markdown

  1. Can you verify it's GFM?
  2. Where can I use the markdown? I assume the card description is a must but maybe also card name? Anywhere else?

@xet7
Copy link
Member
xet7 commented Apr 17, 2019

@shaygover

  1. I don't know does perak include all of GitHub markdown. Please try those GFM examples, and if there is differences, please add info to that Wekan wiki page. You can also search these Wekan GitHub issues and add list of markdown bugs to wiki.

  2. Please add to Wekan wiki page where it works, please test. Maybe it works at some of these, you could test:

  • card titles
  • card descriptions
  • checklist titles
  • checklist items
  • board titles
  • board descriptions
  • Custom Fields text fields
  • maybe somewhere else

If markdown does not work somewhere, I could try adding it.

Thanks!

@shaygover
Copy link
Author
shaygover commented Apr 18, 2019 •
edited
Loading

@xet7 I have some bad news:
It's appears that the parser is using v0.3.1 of marked.js (current is 0.6.2). That means it's either support gfm 0.27 or 0.28 (Current is 0.29). I can attempt to build it against a newer version but my knowledge of js and node is 0 so I'll need some way to test it.

@xet7
Copy link
Member
xet7 commented Apr 18, 2019

@shaygover

Thanks for info, I will try to update marked.js to newer version.

xet7 added a commit that referenced this issue Apr 18, 2019
@xet7
Update to newest GitHub flawored markdown.
ba4d8b0 
Thanks to shaygover and xet7 !

Related #2334
@xet7
Copy link
Member
xet7 commented Apr 20, 2019

@shaygover

Please try newest Wekan v2.61, it has newest markdown.

@shaygover
Copy link
Author
shaygover commented Apr 24, 2019 •
edited by xet7
Loading

@xet7
So where it works is:

  • Card name.
  • Board name - Works on board view only.
  • Card description, list and checklists.

Where it doesn't:

  • List name.
  • Custom fields.
  • Label name

Board name:

mark1

and:

mark2

xet7 added a commit that referenced this issue May 11, 2019
@xet7
- [View markdown on List names, Custom Fields (Text and Dropdown), La…
b795115 
…bel names,

  All Boards view Board names and Board descriptions](#2334).

Thanks to shaygover and xet7 !

Related #2334
@xet7 xet7 mentioned this issue May 12, 2019
Open
@xet7 xet7 mentioned this issue May 21, 2019
Closed
@xet7
Copy link
Member
xet7 commented May 21, 2019

@shaygover

It seems Checklist on markdown does not work yet. Do you have ideas howto get it working? Or does it work with some specific syntax?

@shaygover
Copy link
Author

I only checked basic markup like bold and italics. Other advanced syntax you think it would be good idea to check? I would like to batch check them all

@xet7
Copy link
Member
xet7 commented Aug 8, 2019

@shaygover

This is maybe shortest syntax check page:
https://guides.github.com/features/mastering-markdown/

Sure there is also more complete specs:
https://marked.js.org/#/README.md
https://github.github.com/gfm/
https://spec.commonmark.org/0.29/

Thanks!

This was referenced Sep 6, 2019
Closed
Closed
@xet7 xet7 closed this as completed Apr 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@xet7 @shaygover
0