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

feat: Allow rich text editing of Markdown #45

Merged
merged 3 commits into from
Sep 10, 2024
Merged

feat: Allow rich text editing of Markdown #45

merged 3 commits into from
Sep 10, 2024

Conversation

evadecker
Copy link
Member

@evadecker evadecker commented Sep 9, 2024

What changed?

  • Add a new RichTextEditor component using https://mdxeditor.dev/
  • Remove existing Write / Preview tabs for rich text within the admin
  • Add .prose styles using tailwindcss-typography
  • Fix some color styles for table headings and select dropdowns

Why?

Using a rich text editor to make changes to Markdown is more user-friendly than requiring users to write in raw markdown.

How was this change made?

  • Installed the package
  • Created a new RichTextEditor component which imports the package along with select plugins and styles

How was this tested?

Manual testing.

Anything else?

Created two follow-up issues:

Copy link

changeset-bot bot commented Sep 9, 2024

🦋 Changeset detected

Latest commit: 63b2679

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
namesake Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link
Contributor

github-actions bot commented Sep 9, 2024

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 4.21%
⬇️ -0.04%
117 / 2774
🔵 Statements 4.21%
⬇️ -0.04%
117 / 2774
🔵 Functions 1.36%
⬇️ -0.02%
1 / 73
🔵 Branches 4.41%
⬇️ -0.06%
3 / 68
File Coverage
File Stmts % Branch % Funcs % Lines Uncovered Lines
Changed Files
src/components/shared/Card.tsx 0% 0% 0% 0% 1, 8-13, 16, 19
src/components/shared/RichTextEditor.tsx 0% 0% 0% 0% 1, 13-15, 19-20, 22-40, 43-44, 47
src/components/shared/Select.tsx 0% 0% 0% 0% 1, 11-14, 19-20, 22-32, 43-56, 59-64, 67-72, 74, 79, 81-83, 85-86, 88-89
src/components/shared/Table.tsx 0% 0% 0% 0% 1, 23-26, 28-31, 34, 36-39, 41-44, 46-52, 55-65, 67-70, 76, 82, 84-86, 88-93, 97-102, 104, 107, 110, 112-115, 117-123, 125-129, 132-134, 137, 140, 142-146, 148-150, 152-154
src/components/shared/index.ts 0% 0% 0% 0% 1-19, 26-41, 49-57
src/routes/admin/quests/$questId.tsx 0% 0% 0% 0% 1-5, 15, 17-19, 21-29, 31-33, 35-38, 40-45, 47-51, 53-62, 70, 73-74, 78-85, 87-89, 92, 102
Generated in workflow #30

@evadecker evadecker merged commit 6dbc67d into main Sep 10, 2024
6 checks passed
@evadecker evadecker deleted the rich-editor branch September 10, 2024 02:27
@github-actions github-actions bot mentioned this pull request Sep 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant