indentlabs / indentlabs/notebook

Documents with markdown don't format well in the hover preview

Open
#351 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Bug Good First Issue
Dominant language
HTML
Stars
410
Forks
78
Avg merge
1d
Merged PRs (30d)
9

Description

I'd like to suggest adding a feature of easier formatting when creating documents on notebook.

For example, if I go to create a new document rather than having to highlight text and then apply bolding it'd be easier if I could use key commands like Ctrl + B or use Markdown to format the documents.

As it stands now, when using markdown in a document it will sometimes apply the formatting when hovering over the document but actually viewing the document (NOT EDITING) just shows the markdown formatting.

In other words, it'd just be nice to have easier ways of formatting instead of having to select text and choose from the menu.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the notebook document editor and compare markdown behavior in the hover preview with the read-only document view. Done means markdown formatting is rendered consistently when viewing a document, while the requested keyboard-based formatting options are considered against the existing editor behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
content, frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.