search

material-components / material-components-site-generator

Generator of Material Components documentation sites.
Apache License 2.0
79 stars 40 forks source link

Codelab styles #15

Closed jonathanzong closed 7 years ago

jonathanzong commented 7 years ago

This change adds a stylesheet scoped to the codelab documents that we will be generating using site generator.

The md source lives here: https://github.com/material-components/material-components-web/tree/master/docs/codelabs/building-beautiful-sites/docsite

cc @yeelan0319

shyndman commented 7 years ago

Are you sure this will be the singular codelab for this project? Because if you were to add a new codelab at some point, you'd have to move the existing content and could potentially end up with a bunch of broken links pointing to you.

Also, I'd be inclined to inline these styles in the page if they're infrequently used.

jonathanzong commented 7 years ago

I see your point about inlining, but these styles should be applied to all codelab pages and I'm not sure if CSS in markdown will hold up long term. What are your thoughts?

Re the codelab content: I think the URLs and folder structures are up for discussion; however, we need to use this codelab for SPAN tomorrow (where it will for sure be the only one) and there aren't currently any external links pointing at it, so I think that's something to follow up with later (in the design doc that I shared, which will be owned by @willlarche and @yeelan0319 after my internship ends tomorrow).

shyndman commented 7 years ago

Won't there be external links pointing at it after tomorrow? Later's too late.

I'd nest this under /docs personally, and I'd give it a URL that won't need to be changed. /docs/span-2017-codelab/ maybe?

shyndman commented 7 years ago

Hm, actually. I'm not sure that's good. The side nav may show every child page while on /docs.

If so, /codelabs/span-2017/ is probably good. Or maybe /codelabs/span-pittsburgh-2017/?

shyndman commented 7 years ago

Oh, and my thoughts on the styles? I'm not convinced this isn't a one-off, but that said, the cost is almost nothing, so they can stay.