Skip to content

Display markdown in activities#310

Merged
joanagmaia merged 2 commits intomainfrom
enhancement/display-md-in-activities
Dec 6, 2022
Merged

Display markdown in activities#310
joanagmaia merged 2 commits intomainfrom
enhancement/display-md-in-activities

Conversation

@joanagmaia
Copy link
Copy Markdown
Contributor

@joanagmaia joanagmaia commented Dec 5, 2022

Changes proposed ✍️

  • Added marked package to handle markdown parsing
  • Added html.scss file to allow for proper list styling in parsed html
  • Update sanitization rules to allow for markdown checklists (checkboxes)
  • Create a marked plugin to reuse the parse function globally throughout the components

Relates to task
Relates to issue

Screenshots (front-end changes only)

Screenshot 2022-12-05 at 12 32 03
Screenshot 2022-12-05 at 12 31 57

Checklist ✅

  • Label appropriately with Feature, Enhancement, or Bug.
  • Tests are passing.
  • New backend functionality has been unit-tested.
  • Environment variables have been updated:
    • Local frontend configuration: frontend/.env.dist.local, frontend/.env.dist.composed.
    • Local backend: backend/.env.dist.local, backend/.env.dist.composed.
    • Configuration docs have been updated.
    • Team members only: update environment variables in override, staging and production env. files and trigger update config script.
  • API documentation has been updated (if necessary) (see docs on API documentation).
  • Quality standards are met.
  • All changes have been tested in a staging site.
  • All changes are working locally running crowd.dev's Docker local environment.

@joanagmaia joanagmaia added the Improvement Created by Linear-GitHub Sync label Dec 5, 2022
@joanagmaia joanagmaia requested a review from mariobalca December 5, 2022 13:46
@joanagmaia joanagmaia self-assigned this Dec 5, 2022
Copy link
Copy Markdown
Contributor

@mariobalca mariobalca left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!
The only thing that we need to keep in mind, but it's not a blocker to merge, is that by using a plugin, $marked won't be available to use within components built with the Composition API — we might need to create a component (with the Options API) just to render markdown with this new plugin (as well as the sanatize one).
Other that that, great job! Thanks for taking care of this 🙌

@joanagmaia joanagmaia merged commit 82c7166 into main Dec 6, 2022
@joanagmaia joanagmaia deleted the enhancement/display-md-in-activities branch December 6, 2022 11:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Improvement Created by Linear-GitHub Sync

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants