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

Formalize spec for SSMD #2

Open
jayjlawrence opened this issue Dec 5, 2018 · 2 comments
Open

Formalize spec for SSMD #2

jayjlawrence opened this issue Dec 5, 2018 · 2 comments

Comments

@jayjlawrence
Copy link

As I embrace Markdown (CommonMark) for my documentation needs I am really keen on SSMD for speech requirements.

Learning from Markdown's past I think we should invest in creation of a spec for SSMD that's built off of CommonMark to avoid future issues.

Thoughts?

@jayjlawrence
Copy link
Author

Here's a couple of references. First John Gruber's initial spec: https://daringfireball.net/projects/markdown/syntax

And now what CommonMark has refined it to:
https://spec.commonmark.org/0.28/

@machisuji
Copy link
Owner

You mean the SSMD spec should follow the general structure of the common mark spec you linked?
I guess I could try to describe the different cases in a bit more detail and make sure to avoid any ambiguities.

The general idea seems to be the same at least between CommonMark's and our SPECIFICATION.MD looking at this section in the common mark spec:

This document attempts to specify Markdown syntax unambiguously. It contains many examples with side-by-side Markdown and HTML. These are intended to double as conformance tests. An accompanying script spec_tests.py can be used to run the tests against any Markdown program:

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

2 participants