idyll-lang / docs-redux Goto Github PK

From @bclinkinbeard

I don't know if this goes here or in the docs-redux repo, but I keep picturing something and wanted to write it down.

I think the editor is compelling enough that it should be front and center. I think a great homepage would be the logo, a headline, a couple sentences of description, and then the editor inline. Controls along the top of the editor could allow you to switch between pre-made examples (that you could of course edit) or start from scratch. We could also implement live layout and theme switching like I did in Literasee.

If we did those things and ported the existing examples to work inside it I think we'd have a hell of a site. People could understand the project in 20 seconds.

It would be nice to have a spot to announce new releases, updates to the project, etc. etc. This could be in the form of a simple (powered by Idyll?) blog.

For reference on how to do this in next.js, see my personal site, which implements something similar, e.g. https://github.com/mathisonian/mathisonian.github.io/blob/master/pages/writing/apparatus.js

All of these would be very nice to have:

• generate component documentation directly from the idyll-components module
• figure out a story for versioning the documentation
• basic blog post template for announcements, etc.
• move this repo back to idyll-lang/idyll
• add more examples to gallery
• iframe in examples in gallery so we can overlay links to the source, etc.
• syntax highlighting

For example articles that get linked from the home page, it would be nice to iframe them in so that we can add overlay links for "source", "back to idyll docs", etc.

For some prior art doing this with next.js, see my personal site https://github.com/mathisonian/mathisonian.github.io/blob/master/pages/writing/autumnal-colors.js
https://github.com/mathisonian/mathisonian.github.io/blob/master/helpers/iframe-post.js