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

Consider using Markdown for the spec rather than HTML #3

Closed
JayBeavers opened this issue Oct 29, 2013 · 7 comments
Closed

Consider using Markdown for the spec rather than HTML #3

JayBeavers opened this issue Oct 29, 2013 · 7 comments

Comments

@JayBeavers
Copy link
Collaborator

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.

@marcoscaceres
Copy link
Contributor

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.

@marcoscaceres
Copy link
Contributor

eer... initially in markdown I mean.

@reconbot
Copy link
Contributor

I can see the value in ReSpec as the end product, but if there's collaboration on github initially markdown does seem smart.

@domenic
Copy link
Collaborator

domenic commented Oct 30, 2013

+1, has been working out well for domenic/promises-unwrapping.

@larsgk
Copy link
Collaborator

larsgk commented Oct 30, 2013

+1 (to keep it simple)

On Wed, Oct 30, 2013 at 3:54 AM, Domenic Denicola
notifications@github.comwrote:

+1, has been working out well for domenic/promises-unwrappinghttps://github.com/domenic/promises-unwrapping
.


Reply to this email directly or view it on GitHubhttps://github.com//issues/3#issuecomment-27361679
.

@marcoscaceres
Copy link
Contributor

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).

@marcoscaceres
Copy link
Contributor

Can you guys take a look at:
https://github.com/whatwg/serial/blob/markdown_convert/index.html

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.

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

5 participants