question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Markdown AST, Improve UX and refactor ?

See original GitHub issue

First of all, thank 圆伞科技 for sponsoring HyperMD! I have some plan to make HyperMD much better:

Markdown AST

  • Parse content and get AST (via CodeMirror Mode? or other libs like marked ?)
  • AST APIs for HyperMD users
    • Read
    • Write
  • Use AST to improve hide-token, shortkeys’ performance and user experience, also for #43

Separated Packges

  • Separate PowerPacks into NPM Packages.
  • A toolchain (or project boilerplate), for the separated npm packages.

Style / Theme

  • By default, hide line numbers, or make them less eye-catching
    • Move [Go back] button of addon/click to somewhere else.
  • Rewrite the theme .scss, make it more configurable (eg. dark mode?)
    • Add more color schemes.
    • Add themes for wide screens ( eg. #28 )
  • Find a better way to deal with external resources. (web fonts and icon images)
  • Remove all require("xxx.css") from source, so that we can make HyperMD less opinioned?

Marketing

  • Better doc and README
  • SEO? some articles? no idea yet.

UX Improving

  • hide-token shall
    • NOT hide tokens that are inside a selection.
    • NOT hide link address while editing an image/link.

However, for now, I’m too busy to maintain HyperMD. The plan also need further discussion. Feel free to leave comments. I think this can start in late October.

Issue Analytics

  • State:open
  • Created 5 years ago
  • Reactions:2
  • Comments:9 (6 by maintainers)

github_iconTop GitHub Comments

2reactions
laobubucommented, Mar 1, 2019

@CoreParadox

Has this made any progress? I love this project, but theming it is a nightmare currently (Unless you have some tips, the 800+ lines of css is quite demotivating)

Check this out: dark theme and light theme. Maybe this is the best trade-off between readable code and HyperMD’s mess.

HyperMD uses lots of tricky methods to make CodeMirror WYSIWYG, which make is almost impossible to write clean css for themes.

Maybe getting rid of CodeMirror is the only solution. Meanwhile, a brand new CodeMirror is coming, and it will make almost all HyperMD tricks broken. That makes me feel demotivating.

1reaction
michaelgmcdcommented, Oct 10, 2018

How about plugins? This is the term used by tools like Draft.js and Eslint. Either way, I think it’s a great idea and the name shouldn’t have too much effect.

Read more comments on GitHub >

github_iconTop Results From Across the Web

The Need For A New Markdown Parser and Why | by TOAST UI
TOAST UI Editor is constantly trying to provide better user experience while maintaining the core identity as a Markdown editor.
Read more >
ASTs, Markdown and MDX
We are going to explore Abstract Syntax Trees (AST) and what Markdown and MDX have to do with them. The code samples in...
Read more >
Refactoring CSS: Strategy, Regression Testing And ...
Let's dive into one of the most effective CSS refactoring strategies and see how we can use it to improve the codebase quickly...
Read more >
How Stripe builds interactive docs with Markdoc
We are building automated refactoring tools that use the AST, making it possible to perform complex edits across our entire body of content...
Read more >
Improving the User Experience of Remote Documentation
How we improved the UX of discovering and using our API Reference documentation by moving rendering from the client-side to the server-side.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found