nicedoc

Generate pretty documentation instantly.

get it
#3 Product of the DayApril 17, 2019
nicedoc.io aims to reduce documentation friction, converting any markup file hosted on github.com into instant beauty documentation.
No generators, hosting extra things or whatever: just focus on writing the content and nicedoc does the rest.
Reviews
  • Ahmad Awais ⚡
    Ahmad Awais ⚡🥑 OSS Dev Advocate & WordPress Core Dev
    Pros: 

    Simple. Easy. Dark Mode.

    Cons: 

    None

    Awesome! 💯

    Ahmad Awais ⚡ has used this product for one week.
  • Pros: 

    Saving a lot of time for landing pages, and forcing Open Source projects to have a well written README file.

    Cons: 

    No cons for the moment

    Useful tools for saving time are always welcome

    Juan Gómez has used this product for one day.
Discussion
You need to become a Contributor to join the discussion.
Kiko Beats
Kiko BeatsMaker@kikobeats · Landing Page Engineer
I'm a regular OSS contributor and I was fatigued since every time I started a fresh project I need to pick a documentation generator and maintain it, so I decided to start this pet project during my work hours at IBM.
Pierrick
Pierrick@pierrickgt · Front-end Developer at Meilleurs Agents
@kikobeats nice idea! It reminds me of https://doxdox.org Would be nice to have a hosted and automated generation of the doc like Doxdox do https://doxdox.org/#getting-started
Rafael Camargo
Rafael Camargo@rcamargo · Developer
Things went all wrong when I clicked on a README link: https://nicedoc.io/glorious-code... 😔
Kiko Beats
Kiko BeatsMaker@kikobeats · Landing Page Engineer
@rcamargo That's because `blob/master` is a git thing added by GitHub, but not necessary for resolving the URL That's the right URL https://nicedoc.io/glorious-code...
Rafael Camargo
Rafael Camargo@rcamargo · Developer
@kikobeats Thanks for your reply. However, would that be an issue? Tough my docs work in Github, wouldn't they necessarily work at Nicedoc and vice-versa? 🤔
Kiko Beats
Kiko BeatsMaker@kikobeats · Landing Page Engineer
@rcamargo I think you're right and expectable that the service resolve that by default. Appreciated if you can open an issue https://github.com/IBM/nicedoc.io 🙂
Kiko Beats
Kiko BeatsMaker@kikobeats · Landing Page Engineer
@rcamargo Thanks for that. It has been addressed and the issue closed https://nicedoc.io/glorious-code... 🙂