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

Should Getting Started, Gallery, & Contribute, & About be a markdown file instead? #19

Open
jina opened this issue May 19, 2017 · 6 comments

Comments

@jina
Copy link

jina commented May 19, 2017

It currently has the html extension but is using markdown content.

https://github.com/bradfrost/style-guide-guide/blob/master/getting-started.html

@jina jina changed the title Should Getting Started be a markdown file instead? Should Getting Started, Gallery, & Contribute be a markdown file instead? May 19, 2017
@jina jina changed the title Should Getting Started, Gallery, & Contribute be a markdown file instead? Should Getting Started, Gallery, & Contribute, & About be a markdown file instead? May 19, 2017
@bradfrost
Copy link
Owner

@jina Good suggestion! These are html files because they're stripped down versions of client projects, which ultimately had quite a bit of HTML content inside of them. I'm not sure if it's worth switching over to .md extensions or not, but I suppose it could go either way.

@jina
Copy link
Author

jina commented May 30, 2017

@bradfrost ah that wasn't really a suggestion. Was more of a potential bug report. But maybe jekyll can parse markdown on non-markdown files? :)

@bradfrost
Copy link
Owner

But maybe jekyll can parse markdown on non-markdown files?

@jina yep, they can! And I suppose the opposite is true too (markdown files can parse HTML). I'm going to leave this as-is for now, mostly because I'm lazy and it's all working correctly. If you want to submit a PR, go for it and I'll buy you a drink! :)

@Ryuno-Ki
Copy link

Ryuno-Ki commented Jun 8, 2017

According to the Markdown „spec” at https://daringfireball.net/projects/markdown/syntax#html HTML in Markdown is totally valid.

@jina
Copy link
Author

jina commented Jun 9, 2017

I know that. :) I wasn't talking about HTML in markdown. I was talking about markdown rendering properly in a file that has an HTML file extension.

@Ryuno-Ki
Copy link

Ryuno-Ki commented Jun 9, 2017

Like reveal.js does?

They are using :octocat: marked

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

3 participants