Hyperapp: Generate "nice" documentation from current markdown files

[eschaefer]

Gitbook can generate some pretty fantastic layouts for documentation by just using the markdown files that already exist for a project. I love the way that Redux displays their docs, which are just generated from markdown files, by Gitbook.

I use the Hyperapp docs quite a bit, but I find the navigation pretty clumsy. Would anyone else benefit from a Redux-like layout? If so, this is something I could start working on, and maybe eventually fold it into the official Hyperapp site at https://hyperapp.js.org/.

[lukejacksonn]

This has been proposed and implemented (not with gitbook, but as a hyperapp)! The idea never gained any traction but it is here (serving old docs) https://lukejacksonn.github.io/hyperapp-wiki

[jorgebucaran]

@eschaefer I certainly would! I created https://github.com/hyperapp/website/issues/7 to track the new website. If we manage to get the docs on the website, then we can make it whatever we want, and don't even need GitBook.

[eschaefer]

@lukejacksonn Cool! I didn't know that had been implemented.

@JorgeBucaran I'm open to anything that can easily generate the docs. I just noticed Gitbook was a pretty turn-key solution that works with the existing markdown structure and is easily themeable. But I like Luke's idea of making it a Hyperapp too 🙌

[eschaefer]

Hey all, I threw together a little example of what I had in mind.

It required these steps:

• Restructured the markdown docs slightly, with clear nesting. This was for gitbook to do its thing.
• Added a download script and doc generation step to the website build.

Let me know what you think. All feedback welcome. If it seems ok, I can make real PRs out of those changes.

[Swizz]

For the record, I made an attempt to generate the website documentation from Hyperapp markdown docs too. A while ago.

https://github.com/Swizz/hyperapp-docs

[eschaefer]

@Swizz cool, I just tried running it but it's not quite working as intended, I think. Getting quite a few 404s.

Has anyone taken a look at my example? If it seems like an acceptable first pass, I'm happy to make real PRs to the website and hyperapp docs.

[jorgebucaran]

@eschaefer #502 was merged, so I am going to close here in favor of https://github.com/hyperapp/website/pull/10.