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(wiki): markdown editor #265

Merged
merged 17 commits into from
Sep 19, 2024

Conversation

AyshaHakeem
Copy link
Collaborator

  • Add a patch to convert 'content' field's value in existing Wiki Page records from Rich Text (HTML) to Markdown
  • Update the 'content' field's type in the Wiki Page Doctype to 'Markdown Editor’
  • Convert existing editor to markdown in the frontend

- Add a patch to convert 'content' field's value in existing Wiki Page records from Rich Text (HTML) to Markdown
- Update the 'content' field's type in the Wiki Page Doctype to 'Markdown Editor’
- Convert existing editor to markdown in the frontend
Copy link

cypress bot commented Sep 7, 2024

Wiki    Run #350

Run Properties:  status check passed Passed #350  •  git commit aa0a9a8871 ℹ️: Merge a7cf1ca4858ba879e27d6aaca5a420c2c5b8ea92 into e1f352102282d8999095a5f554dc...
Project Wiki
Branch Review feat-markdown-editor
Run status status check passed Passed #350
Run duration 00m 23s
Commit git commit aa0a9a8871 ℹ️: Merge a7cf1ca4858ba879e27d6aaca5a420c2c5b8ea92 into e1f352102282d8999095a5f554dc...
Committer Aysha
View all properties for this run ↗︎

Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 0
Tests that did not run due to a developer annotating a test with .skip  Pending 0
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 5
View all changes introduced in this branch ↗︎

wiki/public/js/editor.js Outdated Show resolved Hide resolved
wiki/public/js/render_wiki.js Outdated Show resolved Hide resolved
wiki/public/scss/edit_wiki.scss Show resolved Hide resolved
@shariquerik
Copy link
Member

shariquerik commented Sep 10, 2024

@AyshaHakeem Can you also fix the failing cypress test. Also there are some linter issue

@shariquerik
Copy link
Member

shariquerik commented Sep 10, 2024

Great work by the way👌🏻

Suggestion: Always try to push in multiple and small commits instead of pushing everything in one commit. It will be easier for reviewer to read your PR.

@shariquerik
Copy link
Member

I was testing and tried to create CRM's Introduction page which works perfectly. But I have added a video tag is not visible in edit mode after saving. It is visible in desk but not in portal

image

Desk:
image

Portal:
image

wiki/public/js/editor.js Outdated Show resolved Hide resolved
@AyshaHakeem
Copy link
Collaborator Author

Thank you Shariq for reviewing! @shariquerik
I have made the suggested changes.

Screen.Recording.2024-09-10.at.7.34.03.PM.mov

@shariquerik shariquerik merged commit f210ca3 into frappe:master Sep 19, 2024
6 of 7 checks passed
@kittiu
Copy link

kittiu commented Sep 20, 2024

Hello, my team is working on documentation and more comforatble with rich text.
Is it configurable to go back to use Rich Text?

Note: Just wondering why are we changing the editor?

@shariquerik
Copy link
Member

Note: Just wondering why are we changing the editor?

Markdown is a standard way of writing docs hence the switch.
It take less than an hour to learn Markdown.

@kittiu
Copy link

kittiu commented Sep 21, 2024

Note: Just wondering why are we changing the editor?

Markdown is a standard way of writing docs hence the switch. It take less than an hour to learn Markdown.

OK 👌 just want to get confirmed. Thanks!

@kittiu
Copy link

kittiu commented Sep 22, 2024

@shariquerik we do have problem with wiki writing pane for our local language.

image

This is actually happen in any coding syle pane (i.e., system console) but not rich text. In the pic you will see the cursor position not get along with the real display.

Any hint to solve this?

@kittiu
Copy link

kittiu commented Sep 22, 2024

May be the problem with ace editor.

@0xD0M1M0
Copy link

0xD0M1M0 commented Sep 30, 2024

Note: Just wondering why are we changing the editor?

Markdown is a standard way of writing docs hence the switch. It take less than an hour to learn Markdown.

Definitly not nice. I love markdown, but I cannot expect from all employees to learn it. Really considered the app as it blends in with the users from ERPNext, but I guess I skip it and rather have the people login into a new tool than writing markdown.

Tell someone from HR or the production worker to document in markdown...they will rather quit the job. I don't need the wiki for my software people. I need a software for my peoples knowledge. Easy and quick. Anything else is wired.

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.

4 participants