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

feature request: better preview output with skim #4

Open
rnag opened this issue Apr 1, 2022 · 0 comments
Open

feature request: better preview output with skim #4

rnag opened this issue Apr 1, 2022 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@rnag
Copy link
Owner

rnag commented Apr 1, 2022

  • cargo-rx version: 0.1
  • Rust Compiler (rustc) version: 1.59
  • Operating System: Mac OS X

Description

The current output in preview window displayed with skim is nice and works currently for our purposes, but a future idea might be to customize what gets displayed in preview pane on the right side.

For example, do still want to continue displaying the source code of the example file -- might it make sense to instead display the doc comments, or just any regular comments in the example, for instance? also in that case, would we want to automatically strip out the //! and leading spaces, and format the comments nicely?

Side note: I've noticed that in some projects there are comments or info on a specific example that is encapsulated as part of a separate file, generally a text/markdown file. For example, for an example like my_example.rs, in the same directory there is often a separate my_example.md file which documents info about the example. Maybe, in such cases it would be nice to populate the preview pane with the contents of this markdown file, rather than the source file contents.

Future, future idea: maybe we implement a terminal-based parser for Markdown? I think it would be cool to see **text** be translated as bold text in the terminal, and ## Header as a slightly bigger font size or maybe text with a custom background, for example.

@rnag rnag added enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Apr 1, 2022
@rnag rnag changed the title feature request: better previous output with skim feature request: better preview output with skim Apr 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant