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: Support reStructuredText #72

Open
jugmac00 opened this issue Jul 27, 2023 · 2 comments
Open

Feature request: Support reStructuredText #72

jugmac00 opened this issue Jul 27, 2023 · 2 comments

Comments

@jugmac00
Copy link

While markdown got a lot of traction, reStructuredText ( https://docutils.sourceforge.io/rst.html ) is still very wide-spread especially among Python projects. More often than not when I run frogmouth gh <project> I have no success, as the project uses rst.

Would support for reStructuredText be completely out of scope for this project?

If there are no intentions to add support for it, I would love to see a more specific error message, e.g. something like:

The project is using the reStructuredText format which is not supported.

instead of...

Screenshot from 2023-07-27 07-58-41

@davep
Copy link
Collaborator

davep commented Jul 27, 2023

Keep in mind that while Frogmouth is written in Python, its git forge support isn't aimed solely at Python projects.

Displaying rst files is out of scope, at least for now, but perhaps opening up the list of recognised readme formats and handing off to the web browser would make sense.

As you probably know GitHub (for example) supports many formats: https://stackoverflow.com/a/41112364

@willmcgugan
Copy link
Contributor

I wouldn’t say it’s out if scope exactly. We just don’t have a RST widget for Textual right now. It’s not something we are planning to build in the short term, but I wouldn’t be surprised if that happens eventually.

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

No branches or pull requests

3 participants