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

UI/UX Markdown Quick Start doc #307

Closed
gideonthomas opened this issue May 21, 2015 · 4 comments
Closed

UI/UX Markdown Quick Start doc #307

gideonthomas opened this issue May 21, 2015 · 4 comments
Milestone

Comments

@gideonthomas
Copy link

Allow creating a markdown file to describe instructions for creating web apps which maybe are rendered instead of the default index.html file.

@humphd
Copy link

humphd commented May 21, 2015

Depends on #238 for backend bits.

My idea here is that we introduce conventions around having a markdown file in a multi-file project, and if present, render it along with the preview. For example, imagine if README.md, INSTRUCTIONS.md, LEARN.md, etc were names that triggered the editor to do something different on start-up. Normally we look for an index.html file to render in the preview. However, we could also choose to show a markdown file if present, and/or provide a switchable preview view (maybe tabs?) that let you jump between the preview HTML and the markdown.

This would let us easily support having instructions/tutorials written in markdown inside a project.

@sedge sedge removed this from the Heartbeat 2 - The 1Mb challenge milestone May 27, 2015
@humphd humphd added this to the Thimble MVP milestone Jul 22, 2015
@humphd
Copy link

humphd commented Jul 22, 2015

This is part of what we're discussing for tutorials in MVP, cc @flukeout.

@humphd
Copy link

humphd commented Jul 23, 2015

I've basically got this working in #392 for a tutorial.html file. It's unclear whether or not we want to support Markdown or not, based on conversations with Hannah and Luke. I might rip the MD stuff out.

@humphd
Copy link

humphd commented Jul 30, 2015

This is landed.

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