Comments Feature in CodiMD

hackmdio / codimd

CodiMD - Realtime collaborative markdown notes on all platforms.

https://hackmd.io/c/codimd-documentation

GNU Affero General Public License v3.0

9.31k stars 1.06k forks source link

Comments Feature in CodiMD #1223

Open jakubgs opened 5 years ago

jakubgs commented 5 years ago

I see https://hackmd.io has comments for documents, which is pretty cool. Is that feature ever coming to CodiMD?

zeigerpuppy commented 4 years ago

It would be fantastic to have a way of supporting a commenting side bar with the following features:

comments stored in document using CriticMarkup
tools for add/remove/change/highlight which insert syntax in selected passage
marginal marks in edit and rendered view to show an edit
buttons for accept/reject of edits
tracking of a discussion/chat for each edit
- this is a bit more difficult. Ideally it would be good to retain data in the CriticMarkup format but it woukd be necessary to add autor tag to comments automatically and also to have the option of collapsing comments in the edit view, or else it could become distracting.

In summary, these features would allow multi-user commenting and editing workflow while retaining consistency with the markdown document and multi-user collaboration.

ei8fdb commented 4 years ago

I would be very happy if commenting support was added with 1) markdown comment, 2) email address/name input field, as a beginning?

Is there any progress, or indication if this functionality can be added?

raphaeljolivet commented 3 years ago

For comment threads, this might bloat the markdown content. CriticMarkup should be extended to support reference to external comments, via IDs, as footnotes or separate files (json / separate db) something like : {## 1 ##} ... {## ef18de ##}

Edit: I'm am not the only one to have this idea. I like this poposal :

Lorem ipsum dolor sit amet, consectetur adipiscing elit. {==Vestibulum at
orci magna. Phasellus augue justo, sodales eu pulvinar ac, vulputate eget
nulla.==}{>>[1,2,3,4,5]<<} Mauris massa sem, tempor sed cursus et, semper
tincidunt lacus.

<!-- At the end of markdown document -->
{[1]}: @gsw This is the first comment.
{[2]}: @abc Another comment.
{[3]}: @xyz Yet another comment.
{[4]}: Fourth comment.
{[5]}: Last comment.

stgolem commented 3 years ago

I think we should not mix this and CriticMarkup feature. For us it would be great to have discussion on document outside of document, if we can download it as plain file later.

yanickxia commented 2 years ago

any update for this feature?

Iaskebba commented 2 years ago

I am also curious on an update for this feature? If someone is more familiar with how this feature should be architected I am happy to own it.