GithubHelp home page GithubHelp logo

coast-team / mute Goto Github PK

View Code? Open in Web Editor NEW
123.0 13.0 17.0 20.34 MB

a scalable collaborative document editor with CRDT, P2P and E2EE

Home Page: https://mute.loria.fr/

License: GNU Affero General Public License v3.0

TypeScript 62.64% HTML 9.38% JavaScript 17.41% Dockerfile 0.29% SCSS 8.91% Shell 1.28% Batchfile 0.08%
crdt p2p webrtc offline-capable e2ee collaborative-editing collaborative document collaboration collaborative-writing

mute's People

Contributors

baptistehubert avatar cedricenclos avatar isharaherbacha avatar jpeisenbarth avatar kalitine avatar matthieunicolas avatar mcdostone avatar menou2u avatar oster avatar quentin-tardivon avatar rigelk avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

mute's Issues

As a User I want to see as much as possible Rich Text editor

Find below a list of features about Rich Text Editor.
This list is based on this Markdown Cheatsheet. If there are leftovers, do not hesitate to notice it !

Most of those features work thanks to HyperMD.

If there's no particular mention to it, the feature runs on both Chrome and Firefox.

Inline rendered style Markdown ( #26 )

  • Headers (from H1 to H6)
  • Look alike H1 via = line
  • Look alike H2 via - line
  • Integration of code via ```
  • Bold style (** and __)
  • Italic style (* and _)
  • Both bold and italic style (sometimes the syntax does not show up well when it is focused)
  • Crossed style via ~~
  • Lists (1., *, - and +)
  • Paragraph within lists via ⋅⋅⋅
  • Tables
  • Quotations via > (sometimes if there's syntax inside it does not show up well when it is focused)
  • Inline HTML (balises are highlighted but not interpreted)
  • Horizontal rule (---, *** or ___ lines)
  • Links
  • Integrate shortcuts ( #21 )

Handling images ( #43 )

  • Load images from an URL with a reference
  • Load images from an URL without a reference
  • Load images from clipboard

Math formulas rendering ( #28 )

This part works thanks to MathJax, a lib included in HyperMD.

  • Load Math formulas with a preview rendering
  • Load Math formulas without a preview rendering
  • Create an option so the user can choose to have or not a preview
  • List all the configs available for MathJax and find the most suitable one

Opened issues of HyperMD that impact Rich Text Editor

HyperMD's issues are in Mandarin. But there's a Changelog.md file which references the features HyperMD's owner expect to have in future releases.

  • Tables aren't rendered
  • add: Table Parsing
  • add: Table Styling
  • Basically our #20 (edit: closed)
    - [ ] toolbar styling buttons

  • A feature for Math rendering

  • side-by-side preview (with div-to-line mapping support)
  • A possible feature for table
  • add: Table Mode Keyboard Binding

As a User I want to know stored location of each document

Current behavior
For now there are two options for document storage:

  • local storage using IndexDB
  • bot storage

It is possible to get the information (programmatically) in MUTE if the document is in one of them or in both. But currently it is not shown to users.

As a User I want to add basic styles (bold, italic...) to the document using toolbar

Toolbar

It is created via Angular Material Button Toggle

Toolbar buttons (ticked if functionnal)

  • bold
  • italic
  • strikethrough
  • link (url focused in any case)
  • quote (force the syntax to appear at beginning of lines)
  • headers (force the syntax to appear at beginning of lines)
  • lists (force the syntax to appear at beginning of lines)

About toggling

  • buttons must be toggled when the related style is detected

Behaviour

Appearence

  • on a double click that creates a selection for the editor
  • on a mouse-clicked-creating a selection
  • on a Shift+Arrow-creating a selection

Disappearence

  • on a click on the editor
  • on blur
  • when the selection disappear (by moving the cursor thanks to arrows for example)
  • when the selection is removed (by a suppression for example)

Display

Limits

  • Can't use both shortcuts and toggle buttons without desynchronizing toggle buttons highlights. It seems to be related to Angular Material.
  • Double click selections cover __text__ but not **text** (example), so the use of the toolbar in these cases is a bit limited

As a User I want to run through the document edit history

Current behavior
User is NOT ABLE to run through the document edit history.

Expected behavior
User should be able to switch from edit view to history view. Possible features:

  • To be able to identify which document part is written by whom
  • Transition animation between two history states

As a User I want to add basic styles (bold, italic...) to the document using keyboard shortcuts

Find below details about features allowed by shortcuts.

Existing shortcuts

all the #+space, etc... are not considered as shortcuts here

  • Ctrl+B: adding bold (__text__)
  • Ctrl+I: adding emphasis (_text_)
  • Ctrl+Alt+S: adding strikethrough (~~text~~)
  • Ctrl+K : generate link syntax ([text](url to add)]

Features

Adding style

  • bold
  • emphasis
  • links (puts focus on the url part of the syntax so the user can modify it in any case)
  • strikethrough
  • adding style through several lines

Removing style

If selection is formatted [balise]text[balise]

  • bold
  • bold written **text**
  • emphasis
  • emphasis written *text*
  • strikethrough
  • removing a style from a combination of nested ones (e.g.: can remove bold from _**text**_) [1]
  • removing style through several lines

[1] tests were done thanks to this file. If there are missing scenarios please notice it.

Other

  • links : if the link is already set : put focus on the url part of the syntax so the user can modify it

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.