Tracking issue for the first alpha version

[jsimonrichard]

This is certainly an incomplete list, but here are somethings that need to be completed before the first alpha release:

• Add monospace font with italics to ./packages/code/demo
• Sanitization of raw html?
• Correct left padding/margin for block raw html
• Make the tasks' checkbox clickable
  • This will require figuring out how to pass events through the codemirror context. Maybe look at ./packages/core/lib/classBasedEventHandler.ts for some inspiration...?
• Make links clickable
• Basic syntax highlighting in code blocks
• Block quote styling (a block widget of some kind?)
• Make styling for code spans and fences consistent

And then, of course:

• Basic documentation
• Integrate demo into documentation

Skipping for now:

• Make it possible to arrow to a horizontal rule (it currently skips over the line)
• Specify image width/height
• More styling for ordered lists?
• Highlights ==this is highlighted== (extended syntax)
• Change markdown parsing so that adjacent lines are separate paragraphs (make it act like obsidian)
  • Otherwise, this causes some confusing issues with lines adjacent to raw html
• Common keyboard shortcuts (Ctrl-B, Ctrl-I, Ctrl-K)
• Sub- and super-script using surrounding ~ and ^ respectively (extended syntax)

These are still important (and I want to get to some of these things ASAP), but I think we can live without them in alpha release.

[jsimonrichard]

@lishaduck, here's the issue I mentioned in laobubu/HyperMD#85. Let me know if you want to add anything to this list, and/or what you're interested in working on.

I'm afraid I won't be able to make many of my own contributions during the school semester, but I help if you get stuck anywhere.

[lishaduck]

Let me know if you want to add anything to this list

I think what you've got on there is pretty good.

and/or what you're interested in working on.

I'll claim italics, I guess.

I'm afraid I won't be able to make many of my own contributions during the school semester, but I help if you get stuck anywhere.

Yeah, I'm on a short break for MLK day, so I've got some time today, but school'll speed up soon for me as well.

---

I guess for me:

• Can you set dev to the default branch?
• Can you set up pkg.pr.new so it's consumable?

[jsimonrichard]

I guess for me:

• Can you set dev to the default branch?

• Can you set up pkg.pr.new so it's consumable?

Done

[lishaduck]

I think italics is already supported?

I'm working on an editor with a friend, and they noted that this version doesn't have keyboard shortcuts, so I'd add that to (the bottom of) the list.

Oh, and I looked into sanitation. If we want to support hooking into the rehype ecosystem, they have a sanitizer. If not, there's DOMPurify. html-sanitizer is meant for server-based use, so it's not really applicable here.

[jsimonrichard]

I've found sanitize-html works pretty well. Rehype is a bit overpowered for this, I think.

But on the italics: yes, the syntax is supported, but the text isn't italicized in the editor like bolded text is bolded (unless something strange happened with the demo I ran yesterday).

What kinds of keyboard shortcuts are you looking for?

[lishaduck]

I've found sanitize-html works pretty well. Rehype is a bit overpowered for this, I think.

Oh, I made a typo. I was commenting on that sanitize-html doesn't support web. I think it's fine if people use a bundler (which they'll need to anyway), but still feels a bit concerning as a dependency.
Yeah. If we don't need the unified ecosystem for other stuff, it doesn't make a lot of sense to use it over alternatives.

But on the italics: yes, the syntax is supported, but the text isn't italicized in the editor like bolded text is bolded (unless something strange happened with the demo I ran yesterday).

Just like this, right?

What kinds of keyboard shortcuts are you looking for?

Probably just ⌘+I, ⌘+B, ⌘+K.
The original hypermd had a custom keymap as well, but that's less important for now.

[jsimonrichard]

Oh, I made a typo. I was commenting on that sanitize-html doesn't support web. I think it's fine if people use a bundler (which they'll need to anyway), but still feels a bit concerning as a dependency.

It supports the web, it just doesn't recommend running in the client because of security issues. Since HyperMD is a client library, we can't control the backend side of whatever project this library is being used in. Having an extra layer on the client to prevent XSS might be helpful, but it seems like codemirror and/or the markdown parser is already doing something because I wasn't able to inject anything problematic... but I'm not sure. Let's leave this for now and focus on the other stuff.

Probably just ⌘+I, ⌘+B, ⌘+K. The original hypermd had a custom keymap as well, but that's less important for now.

I'll add it to the to-do list.

On the italics: it seems like there might be a browser specific issue. I'll play around with this a little bit to see what's going on.

[jsimonrichard]

Okay, the issue is that the monospace font installed on my system doesn't have an italic version. The solution to this (since I expect most applications will want to bundle a font anyway) is to bundle a working font with the demo page.

[lishaduck]

The solution to this (since I expect most applications will want to bundle a font anyway) is to bundle a working font with the demo page.

Really I'd expect the other way. Loading fonts significantly slows down pages, so I'd lean to using Tailwind's monospace default: font-family: ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono", "Courier New", monospace, which I think should support italics? What font is your default?

[jsimonrichard]

You're right, that makes more sense. I guess I was thinking of apps like Obsidian (which includes the Inter font), but tailwind's default should be a better default.

I'm using Noto Sans Mono (Regular).

[lishaduck]

Make it possible to arrow to a horizontal rule (it currently skips over the line)

Interestingly, you can arrow through frontmatter, which gets rendered as horizontal rules 🤷‍♂

[jsimonrichard]

Hi everyone, I made an update to the task list at the top of this issue. I wanted to minimize what would be needed for an alpha version so we can get a release into people's hands (for feedback).

That will also make it possible for me to create a VS Code extension powered by this project, which I've been wanting to have for a while.

[luoluoqixi]

Here is a CodeMirror 6 library. It seems to offer some reference value.

https://codeberg.org/retronav/ixora

[jsimonrichard]

Here is a CodeMirror 6 library. It seems to offer some reference value.

https://codeberg.org/retronav/ixora

Thanks! I'll take a look.