New Documentation Site with Markdown Docs

[smashedr]

These docs are written in plain text using Markdown, built with VitePress, and deployed to GitHub Pages.

• Website: https://docker-deploy.cssnr.com/
• Repository: https://github.com/cssnr/stack-deploy-docs

Editing the docs with the live preview is super easy and intuitive. All you have to do is clone the project, install it and run dev. Instructions are on the README.md and CONTRIBUTING.md respectively.

Building and deploying is also super simple. All my VitePress sites use this exact same workflow: https://github.com/cssnr/stack-deploy-docs/blob/master/.github/workflows/pages.yaml

This is the first documentation site I have written for a GitHub Action and I already like it. It is easier to write and browse compared to a GitHub README.md.

Feature Showcase

I added a StackTable.vue custom component to show a comparison of all the available actions on the marketplace.

• https://docker-deploy.cssnr.com/guides/resources#action-comparison

Why VitePress

• Minimal repository footprint. You only need 1 configuration file, and your markdown files.
• Single Page Application with all the expected features of a docs site out of the box.
• Easily write the docs with Vite dev server to live preview changes with hot module reloading.
• Easily extend and customize with Vue to add powerful features with minimal boilerplate.

For more information, read the What is VitePress? doc on vitepress.dev.

More VitePress

Some other VitePress sites I have authored, including a VitePress Plugin.

• https://django-files.github.io/
• https://zipline-android.cssnr.com/
• https://vitepress-swiper.cssnr.com/
• https://portainer-deploy.cssnr.com/

---

TLDR? Let me know if you have any feedback on the new docs site: https://docker-deploy.cssnr.com/

Feel free to post any questions or suggestions on this thread...