-
Notifications
You must be signed in to change notification settings - Fork 48
-
Notifications
You must be signed in to change notification settings - Fork 48
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
Consider using Markdown for the spec rather than HTML #3
Comments
Hmm... that would be nice, but we would eventually need to convert this to a "real" HTML spec. Using ReSpec has a lot of advantages, like it generates the WebIDL, does all the cross-references, and handles a ton of other stuff. We could certainly develop proposals using markup initially then integrate them into the spec if that would help. |
eer... initially in markdown I mean. |
I can see the value in ReSpec as the end product, but if there's collaboration on github initially markdown does seem smart. |
+1, has been working out well for domenic/promises-unwrapping. |
+1 (to keep it simple) On Wed, Oct 30, 2013 at 3:54 AM, Domenic Denicola
|
Turns out ReSpec also supports markdown. I'll convert the spec. However, not all parts can be converted (obviously!), but we get most of it in md. If the end result is still not palatable, then we can switch to just markdown. However, it will mean eventually having to do everything again, so, I would really like us to avoid that! (having done specs for 7 years, I know first hand how much of a pain that can be). |
Can you guys take a look at: Let me know if that will work. That allows us to keep the WebIDL auto-generated (makes it much more maintainable!), but let's us have all the other prose as markdown. |
This would give us a lovely view right in the Github window and would allow us to use Github's web based editor for modifying the content.
The text was updated successfully, but these errors were encountered: