docsy VS VuePress

> cd (The root directory of the Git project. themes exists in current) > git submodule add https://github.com/google/docsy.git themes/docsy

Site URL Hugo theme introduction https://themes.gohugo.io/themes/docsy/ Sample/Demo https://example.docsy.dev/ Documentation https://www.docsy.dev/ Repository https://github.com/google/docsy

A set of Hugo documentation templates for launching open source content. Use case(s): Documentation Author: The Docsy Authors Minimum Hugo version: 0.73.0 Github stars: 1706 Last updated: 2022-05-14 License: Apache-2.0

Download Docsy Docsy demo site ​​​​Minimum Hugo version: 0.73 GitHub stars: 1.7k License: Apache-2.0

Background: I've been a technical writer for 9 years. 6 at Google, 3 as the only writer at an IoT startup.

I helped Corrily with their docs [1] in August. They were interested in readme.io. I wasn't keen on it because I had worked with Retool a few years back and had found readme.io lacking. But I was pleasantly surprised by how much readme.io has progressed since then! If you're looking for a documentation product that is very easy to update and mostly just works, then it's worth checking out.

On https://web.dev I was introduced to Eleventy. Eleventy [2] is now my go to. The documentation for Elecenty itself is very strangely organized and needs a refactor. But I have found that there is always a way to accomplish whatever I need, and usually elegantly.

Another project worth checking out is Docsy [3]. This is a Jekyll template specifically created for technical documentation.

Back at the IoT startup I had to set up the whole documentation system / tooling myself. I used Sphinx and deployed to Heroku. Haven't used Sphinx since then but I remember being satisfied with it back then.

[1] https://docs.corrily.com

[2] https://11ty.dev

[3] https://docsy.dev

I haven't used either of these, but I've heard good things about both https://github.com/google/docsy and https://thegooddocsproject.dev/. If you choose to use either of these, I'd love to hear about it. I have coworkers who contribute to both of them.

VuePress - when I searched if it's supporting what I want (conditional rendering), the first result is a bug issue opened 4 years ago, so it doesn't seem to be a good option.

I'm new to IA Writer, and I'm wanting to use it to draft posts for my Vuepress site.

VitePress is listed in the documents as VuePress' little brother, and it is built on top of Vite. For those that don't know Vite is a build tool that aims to provide a faster and leaner development experience for modern web projects so it might sense to pair it with a static site generator such as VitePress. One of the original problems with VuePress was that it was a Webpack app and it took a lot of time to spin up a dev server for just a simple doc. VitePress solves these problems with nearly instant server start, an on-demand compilation that only compiles the page being served, and lightning-fast HMR. Let's get started!

VuePress

Trying to help build a design system at work in my spare time; no clue if it will go anywhere but it’s fun regardless. I asked the Elm Slack group what the equivalent of React Storybook. Specifically, I wanted a way to build a documentation website like Vuepress with the ability to host native Elm code to showcase components. They pointed me to Elm Book. While Elm Book has built-in theming capabilities, I needed CSS control over my components. While they support elm-css, I wanted the ability to use TailwindCSS. The Elm libraries haven’t kept up with Tailwind’s changes, which is fine; writing raw Tailwind CSS on Elm HTML functions is easy and co-located with the component you’re styling.

Vuepress is a minimalistic static site generator with a Vue-powered theming system and a default theme that has been optimized for writing technical documentation.

You can use auto-import or Vue-Press. You can reference my-project using the auto-import plugin

This parameter is default and there is a issue.

A few popular examples of static site generators include Hugo, Jekyll, and VuePress.