Render marked up files like READMEs
Reported by Dag Odenhall | June 2nd, 2008 @ 02:16 AM
For example, if a file is detected as a markdown file, render the markdown in the file view just like README previews are rendered now. If one wishes to see the actual mark up, one needs only click raw anyway. This may be controversial, some may prefer a syntax highlighted representation of the markdown text, which is why this is more of a request for comments than a solid feature request.
Images are already rendered in-line in file views, so this isn't all new from the usual plain-but-highlighted-text...
It will be pretty and almost like a git-powered wiki-for-free for projects keeping documentation in supported formats (such as rake with its doc/*.rdoc guides) or projects using tools such as webby to render their websites (such as datamapper with its dm-www repo). It would likely be easier to implement than solid syntax highlighting for all these markup languages.
Comments?
Comments and changes to this ticket
-
Alex Coles June 2nd, 2008 @ 12:35 PM
+1. I think this would cool. Typically people browse the tree online to read things in a read-able format. So this would make a lot of sense.
Kind of similar to #105, would be nice to have rendered diffs too of Markdown/Textile formatted docs (kind of like Instiki's rendered diffs).
-
Patrick Altman July 7th, 2008 @ 01:50 PM
- → Tag changed from “” to “display feature idea request-for-comments”
+1
I would love to see this at least as a user configurable option (in the case that it was controversial as the Dag suggests, make it something that can be turned on or off for the user -- you could then "sneak" it in by defaulting it to off).
That being said, I agree with Alex and think that this would be immensely useful.
-
defunkt July 8th, 2008 @ 09:11 PM
- → Assigned user changed from “” to “defunkt”
Is this because we don't have a Git-powered Markdown filtered wiki? That should be coming soon, after we roll out some more big features in the next two weeks.
Are any projects already storing .markdown or .textile files in their repository?
-
Patrick Altman July 8th, 2008 @ 09:30 PM
- no changes were found...
-
-
Patrick Altman July 9th, 2008 @ 09:27 PM
I previously responded via email, but it obviously didn't pick up my response. here is what i said:
On Jul 8, 2008, at 4:11 PM, Lighthouse wrote:
No, I'd rather keep my docs in my source tree than disconnected in the wiki.
http://github.com/paltman/django...
==================================================
defunkt updated this ticket at July 08, 2008 21:11
Status: new
Is this because we don't have a Git-powered Markdown filtered wiki? That should be coming soon, after we roll out some more big features in the next two weeks.
Are any projects already storing .markdown or .textile files in their repository?
-
-
Patrick Altman July 9th, 2008 @ 10:55 PM
that's not at all what I was hoping for or trying to describe in my previous messages.
-
defunkt July 15th, 2008 @ 02:56 AM
- → State changed from “new” to “resolved”
-
Please Login or create a free account to add a new comment.
You can update this ticket by sending an email to from your email client. (help)
Create your profile
Help contribute to this project by taking a few moments to create your personal profile. Create your profile »
