style-guide-guide icon indicating copy to clipboard operation
style-guide-guide copied to clipboard

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

Open jina opened this issue 7 years ago • 6 comments

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

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

jina avatar May 19 '17 14:05 jina

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

bradfrost avatar May 21 '17 20:05 bradfrost

@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? :)

jina avatar May 30 '17 03:05 jina

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! :)

bradfrost avatar Jun 02 '17 02:06 bradfrost

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

Ryuno-Ki avatar Jun 08 '17 18:06 Ryuno-Ki

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.

jina avatar Jun 09 '17 15:06 jina

Like reveal.js does?

They are using :octocat: marked

Ryuno-Ki avatar Jun 09 '17 21:06 Ryuno-Ki