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

New modes optimized for reading markdown content (as opposed to editing it) #296

Closed
vermiculus opened this issue Dec 3, 2017 · 5 comments

Comments

@vermiculus
Copy link
Contributor

Expected Behavior

I suggest a {markdown,gfm}-view-mode that derives from the normal editing modes. These would be optimized for reading, not editing.

Actual Behavior

The naive approach is to enable read-only-mode in the buffer, but this puts all the navigation commands far out of reach.

I'm going to be including a very basic concept of gfm-view-mode in an upcoming version of Magithub, but it'd be nice if that definition could come from this package instead 😄

@jrblevin
Copy link
Owner

jrblevin commented Dec 3, 2017

Thanks, I am on board with this idea. Something along these lines was also suggested in #130.

Just checking, do you know about hidden markup mode (M-x markdown-toggle-markup-hiding or C-c C-x C-m)? It seems that this could be solved simply by a mode that turns on read-only-mode and sets markdown-hide-markup. Perhaps some maintenance work to make sure the editing commands fail gracefully. Is there anything else it should do?

@vermiculus
Copy link
Contributor Author

I'm on a subpar network right now so sorry I can't expand more, but putting more navigation at your fingertips. Even binding n/p to section movement proofed very beneficial. More careful thought could bring even greater benefit.

@vermiculus
Copy link
Contributor Author

I created such a mode for Magithub and found it dramatically improved usability with just those two additional bindings. I don't use markdown-mode enough to know what else would be routinely useful.

I did know about markdown-hide-markup -- it's very cool 😄

jrblevin added a commit that referenced this issue Dec 11, 2017
@jrblevin
Copy link
Owner

Thanks for demonstrating with the gfm-view-mode in Magithub. Inspired by that, I added two view modes in the above referenced commit. Let me know if you have thoughts or suggestions...

@vermiculus
Copy link
Contributor Author

Awesome! This is just the kind of thing I was looking for 😄

Thanks!

This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants