3 ms·

I really want to find a great open-source JAMStack documentation site for APIs. Does one exist somewhere?

chrisacky 7y ago
I'm planning on migrating all our Postman documentation away to https://github.com/slatedocs/slate https://github.com/slatedocs/slate if that's what you mean. PS. The reason why we're moving away from Postman is due to some tiny issue[1] that has caused lots of "you need to click here to see everthing" conversations. [1] : https://github.com/postmanlabs/postman-app-support/issues/5789 https://github.com/postmanlabs/postman-app-support/issues/57...
- yingw787 7y ago
  I'm not quite sure what you mean by "Postman documentation". Is this Postman's documentation or documentation for other APIs (not sure if Postman has an OpenAPI spec?). I found slate, and it's super cool, but I haven't used it myself. There might be some pipelining involved, from my understanding of projects like https://github.com/Mermade/widdershins https://github.com/Mermade/widdershins where you convert OpenAPI specs to markdown? I think the good folks over at getstream.io used slate as a base for their docs CMS and loved it enough to write about it, and I'd love to read more about slate in production. Looking forward to when you finish your migration and if you write about it!
40four 7y ago
Edit: think I misunderstood :) I have used Vuepress before, it is geared towards building documentation. I believe Vue’s own docs use it. I had a good experience with it, would recommend! https://vuepress.vuejs.org/ https://vuepress.vuejs.org/
- yingw787 7y ago
  Hmm, I found this theme and it wasn't bad: https://github.com/FriendlyUser/vuepress-theme-cool https://github.com/FriendlyUser/vuepress-theme-cool Do you know of any other Vuepress documentation themes, or where I could find them? I like Hugo because they have a curated open-source showcase of different themes @ themes.gohugo.io, so you don't have to search around the web to find stuff.
mattgreg 7y ago
We may have built it for you...if you go to our /learn page check out how we built the documentation sections. all the source is md in github. here is an example: https://www.ockam.io/learn/proposals/0003-key-agreement-xx/ https://www.ockam.io/learn/proposals/0003-key-agreement-xx/ note the 'edit on github' link on the right to get to the source.
- yingw787 7y ago
  I just git cloned, installed, and ran dev, and yeah it does have everything! I thought it was just the landing page! This is really cool, thank you very much for open sourcing this!

I'm planning on migrating all our Postman documentation away to https://github.com/slatedocs/slate https://github.com/slatedocs/slate if that's what you mean. PS. The reason why we're moving away from Postman is due to some tiny issue[1] that has caused lots of "you need to click here to see everthing" conversations. [1] : https://github.com/postmanlabs/postman-app-support/issues/5789 https://github.com/postmanlabs/postman-app-support/issues/57...

yingw787 7y ago
I'm not quite sure what you mean by "Postman documentation". Is this Postman's documentation or documentation for other APIs (not sure if Postman has an OpenAPI spec?). I found slate, and it's super cool, but I haven't used it myself. There might be some pipelining involved, from my understanding of projects like https://github.com/Mermade/widdershins https://github.com/Mermade/widdershins where you convert OpenAPI specs to markdown? I think the good folks over at getstream.io used slate as a base for their docs CMS and loved it enough to write about it, and I'd love to read more about slate in production. Looking forward to when you finish your migration and if you write about it!

40four 7y ago

Edit: think I misunderstood :) I have used Vuepress before, it is geared towards building documentation. I believe Vue’s own docs use it. I had a good experience with it, would recommend! https://vuepress.vuejs.org/ https://vuepress.vuejs.org/

yingw787 7y ago
Hmm, I found this theme and it wasn't bad: https://github.com/FriendlyUser/vuepress-theme-cool https://github.com/FriendlyUser/vuepress-theme-cool Do you know of any other Vuepress documentation themes, or where I could find them? I like Hugo because they have a curated open-source showcase of different themes @ themes.gohugo.io, so you don't have to search around the web to find stuff.

mattgreg 7y ago

We may have built it for you...if you go to our /learn page check out how we built the documentation sections. all the source is md in github. here is an example: https://www.ockam.io/learn/proposals/0003-key-agreement-xx/ https://www.ockam.io/learn/proposals/0003-key-agreement-xx/ note the 'edit on github' link on the right to get to the source.

yingw787 7y ago
I just git cloned, installed, and ran dev, and yeah it does have everything! I thought it was just the landing page! This is really cool, thank you very much for open sourcing this!