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

CriticMarkdown support #917

Open
offray opened this issue Aug 12, 2018 · 2 comments
Open

CriticMarkdown support #917

offray opened this issue Aug 12, 2018 · 2 comments
Labels
discussion Exchange of some opinions needed

Comments

@offray
Copy link

offray commented Aug 12, 2018

I have seen that there is some discussion about annotations. I think that a good light weight alternative would be to implement CriticMarkdown support. The extension is pretty easy to learn and I think will suffice basic editorial needs.

The only place where I will see some difficulties would be on nested long discussions about a particular piece of text, that is a task where hypothesis is better suited. Maybe some bridge between hypothesis and CodiMD via CriticMarkdown could be developed for that in the future.

@ccoenen
Copy link
Contributor

ccoenen commented Aug 12, 2018

Is this about the workflow or about the new markup tags? I just wonder because you get ++addition++ and ~~strike~~ anyway. Comments could also be included as html-comments <!-- test --> and there's a bunch of highlighting available anyway?

@SISheogorath SISheogorath added the discussion Exchange of some opinions needed label Aug 12, 2018
@offray
Copy link
Author

offray commented Aug 12, 2018

It was about new markup tags that support editorial process. But I think that addition, strike and comments will work anyway (I have never liked the html comments markup, which seems too verbose). I think that CriticMarkdown tries to be more evocative with its syntax: {++something++} is not about underlining it, but about adding something to the text, while {--something--} is about erasing something. Using ++ and -- fenced blocks for this kind of behavior seems more mnemonic for me. And the {>>comment<<} next to highlighting is evocative that this highlight is being commented. For compatibility reasons could be better to use HTML comments, but then there is some lost of the more specific editorial comment .

But yes, at some point this would mean some features collision between CommonMark supported features and the ones of CriticMarkdown. Which makes me wonder how the last one is expected to be integrated with the standardization efforts of the first.

edgarogh pushed a commit to WartaPoirier-corp/codimd that referenced this issue Sep 21, 2021
…s-extract-plugin-1.x

Update dependency mini-css-extract-plugin to v1.3.7 (master)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion Exchange of some opinions needed
Projects
None yet
Development

No branches or pull requests

3 participants