Greenboard

Greenboard

Generate beautiful static api documentation

2 followers

Greenboard is a gatsby theme written in React and sass which generated api documentation from a markdown file. Greenboard is similar to slate docs but comes with additional customization, dark mode, efficient search, responsive etc.
Greenboard gallery image
Greenboard gallery image
Greenboard gallery image
Greenboard gallery image
Greenboard gallery image
Launch Team
Anima - Vibe Coding for Product Teams
Build websites and apps with AI that understands design.
Promoted

What do you think? …

Shamin
Hi Hunters, This is my first product in product hunt and I am really excited to release it. Greenboard is not just a Gatsby theme but a full starter pack for your api documentation. It comes will a lot of features like dark mode, easy customisation etc. and also new features can be added easily with javascript. The code highlighting used by Greenboard is prism.js, there are plenty of themes available for prism and all those themes can be easily integrated to greenboard. As greenboard comes as a theme of Gatsby it has all the features Gatsby has. It is just a starting and I need some valuable suggestions to improve it so that it would be helpful for someone looking to write their API documentation in Gatsby.
Joshua Pinter
Clean AF. Great job!
Shamin
@joshuapinter Thank you so much.
Leo Woods
Really good job on this one!
Shamin
@leo_woods Thank you so much.
tela
Wow, I'm super impressed! This will save me so much time on my API docs. Do you have plans for a way to host or link to SDKs? Also, how does Greenboard work for GraphQL API docs?
Shamin
@tela This was just a starting, I am really excited. I will work to add more features. Currently it generates docs from a markdown file so you can add your GraphQL nodes and queries in it. If you need some help you can contact me on my email shamin616@gmail.com
Vlad Korobov
Great! How do you generate search indexes and what engine is used for it?
Shamin
@vladkorobov I use js-search for indexing the text in the docs. But it is customizable and services like algolia can be easily integrated.
Devanand Premkumar
Pretty neat design. Sure this will help a lot of API developers to expand their documentation in a structured way.
Shamin
@devaonbreaches Thank you so much.