5 ms·
Show HN: Docute – Fast way to create a documentation site
- gfosco 8y agoAlternatively, this is much, much better: https://docusaurus.io/ https://docusaurus.io/
- dancek 8y agoHow is it better? Does it do the same thing?
- wasted_intel 8y agoI've found mkdocs to be fantastic for this, especially when paired with its material theme: https://www.mkdocs.org/ https://www.mkdocs.org/ https://github.com/squidfunk/mkdocs-material https://github.com/squidfunk/mkdocs-material There's a docker image that makes getting started with both quite easy: https://squidfunk.github.io/mkdocs-material/getting-started/#alternative-using-docker https://squidfunk.github.io/mkdocs-material/getting-started/...
- sneak 8y agoIt seems that mkdocs is a generator that requires a build step. Docute does all of that work clientside at render time, according to TFA. That makes it compatible with ipfs with no additional build step, which I think is super cool.
- mygo 8y agoThanks for making this, it looks very nice and I’m always looking for things like this. > renders them as a single-page application. The problem with SPA’s is that unless there’s server-side-rendering with routing, they will not be reliably crawled by search engines. One of the benefits of having published documentation is that each page gets indexed by google and so each page is essentially a hyper-targeted marketing page with specific keywords. Just wanted raise a concern I’ve experienced with hosting websites as SPA’s. I see in your comparisons you list other tools that render static HTML. Do you think in your roadmap you would have an option to export a directory of HTML pages?
- pacoWebConsult 8y ago> If you care about SEO, you may like using tokio [1] to prerender your website. [1]: https://github.com/egoist/tokio https://github.com/egoist/tokio
- egfx 8y agoYes, indeed. Routing on SPA's is HARD. Especially in production. One of these things you have to experience before you fully appreciate.
- stephenr 8y agoI don't get the point. Why is javascript required for this? Static site generators are a thing that exist, and solve this problem a lot more reliably than this will.
- Epskampie 8y agoNo build step. That’s the advantage.
- stephenr 8y agoThere is though. Every time someone visits a page.
- mygo 8y agoThere are no server side components. This appears to be a static site generator in that regard. Just that it outputs a single-paged app as opposed to a linked directory.
- stephenr 8y agoStatic site generator is a very well defined thing. Content, static pages out. This isn't 'generating static pages'. It's rendering a page every time you access it, you've just moved the rendering to the browser's JS runtime.
- iptq 8y agoI don't get what the fear around building is. Many static site generators don't even require you to install additional toolchains[0], so churning out static HTML content from markdown should be just as easy. It's better to spend just a couple minutes setting up a static site generator into your workflow than to have every user who pulls up your STATIC website perform template rendering and all that garbage. I know computers are fast and it doesn't seem like it really makes that much of a difference, but thinking like this often leads to inefficiencies in other applications as well. [0]: https://github.com/keats/gutenberg https://github.com/keats/gutenberg
- corndoge 8y agoIf you write your docs in RST or Markdown, readthedocs is also a great choice. With a GitHub webhook they'll automatically build and publish your docs. Point your own domain at it and it couldn't be easier.
- pingec 8y agoWow, this is beautiful and so simple to start using, I will give it a try.
- marknadal 8y agoNot having a build step makes life 100X easier. We use a similar system (based on UI kit) but I've found Docsify and Docute to be much easier/cleaner. One really cool thing is we added a "interactive coding tutorial" system to the MD renderer, letting you do some pretty powerful documentation demos (see https://gun.eco/docs/Todo-Dapp https://gun.eco/docs/Todo-Dapp for example). This should be able to be packaged up as a plugin for docsify/docute, anybody interested in helping, so other projects can use it out of the box?
- raffleslodge 8y agoJust a heads up, website is down for me.
- simula67 8y agoHN hug of death ?