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

Specify Markdown version for Readme.md #485

Closed
Stephen-Gates opened this issue Jul 5, 2017 · 3 comments
Closed

Specify Markdown version for Readme.md #485

Stephen-Gates opened this issue Jul 5, 2017 · 3 comments

Comments

@Stephen-Gates
Copy link
Contributor

As discussed in the forum I think it would be useful to specify the version of Markdown recommended for the Readme.md file in a Data Package.

I think being explicit about the type of Markdown is good, enabling implementers of:

  • tools to create data packages to only use "tags" that will be rendered correctly on supporting platforms.
  • supporting platforms to have a simpler approach to rendering a defined set of Markdown

I'm leaning towards using CommonMark as a "stricter" implementation of the original Markdown

@Stephen-Gates
Copy link
Contributor Author

Just noticed the link to commonmark.org in https://specs.frictionlessdata.io/data-package/#description (L311) so I'm assuming this is what is meant by "markdown" in the frictionless data specification.

@rufuspollock
Copy link
Contributor

@Stephen-Gates yes - and FWIW I'd incline in processors to gfm style because i think that is useful and common. At the same time i'm not sure it is useful to allow people to specify their version of markdown as it won't help most tooling (they'll just parse as they can).

@Stephen-Gates
Copy link
Contributor Author

Github Flavoured Markdown is based on CommonMark so it probably doesn't matter

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

No branches or pull requests

2 participants