penmark VS vitepress

I've been trying to build a tool that solves that niche problemset of facilitating the edit flow of a dev blog.

I liked Forestry, but wanted something that was embedded directly into my website, so I built Penmark CMS https://penmark.appsinprogress.com/. Inspired by utteranc.es, it uses the GitHub API to make edits directly to your repo. It's definitely a simple CMS but I'm liking it to write for my own blog!

Hi HN,

I've always found editing my blog via desktop editors to be inconvenient, especially when it came to keeping the repository in sync and trying to edit on the go, and relying on an external CMS or tools like the now-discontinued Forestry.io was complex to setup for simple cases and spread my website & workflow over multiple different apps. Around the same time, I discovered utterances [1] on here, a comments widget backed by GitHub for your website. Inspired by that project, I decided to build Penmark.

Penmark is an embeddable CMS for your Markdown-based, GitHub-backed sites. Penmark can be embedded directly into your website, allowing you to access a rich text CMS editing experience without external tools, and while keeping all your site's content in your repository.

It's simple to setup, embed the 3 components (Login, Drafts, Edit Post) that create the CMS experience within your site and add the GitHub app to your repository.

Once you've set it up on your site/repo, you can edit directly from your site, on the go and from any device, and let Penmark take care of all the operations needed to keep your site and repository in sync.

If you want to check it out, the code is open source on GitHub https://github.com/penmark-cms/penmark and I made a docs site to explain how to add it https://penmark.appsinprogress.com/

[1]: https://news.ycombinator.com/item?id=29189923

There is a discussion related to naming on GitHub: https://github.com/vuejs/vitepress/discussions/548

> I initially gave VitePress a different name because I wanted to be able to explore a different architecture without worrying about backwards compat. After shipping the vuejs.org with VitePress, I believe VitePress is flexible enough to be a full replacement of current VuePress while offering better DX and better performance.

Given that version 1 landed as "VitePress" they probably decided to keep the name.

> ...

> I think we should ship VitePress stable as VuePress 3, but I am open to potential questions and concerns.

> Pros: Less confusion in the long run. There will be just one officially maintained SSG with better DX, better performance, and customization that fully aligns with standard Vite-based Vue apps.

> Cons: Potential confusion in the short run, since there are probably a lot of tutorials / integrations targeting VuePress 1. Still I think with the recent Vue 3 switch, users won't be surprised with a major upgrade for VuePress.

I was inspired by a great series of blog posts and decided to adapt the approach to my needs. In this blog post, I will go over the solution I used in my VitePress site but you can also check a more basic example in this CodePen.

While researching which static site generator we would use, we had a lot of frameworks to pick up from, but only some addressed our needs. While choosing, we needed it to have a good "default" template, out-of-the-box plugins, and be easy to extend its functionalities. From our research, the one that matched most criteria and felt the easiest to start and progress with was Vitepress.

They are using the default theme of VitePress which is a great tool for building content-centric websites such as documentation

Thankfully, an entire ecosystem of frameworks makes docs sites easy to build and services that make static sites easy to deploy. In this post, you'll learn how to build a docs site with VitePress and deploy it to the internet with Render.

I have a few Jekyll blogs including my personal one and I haven't had to touch the Jekyll part for quite a while (it takes a while to compile). I just write in Obsidian and then Github takes over.

I also maintain two VitePress[1] sites. Once I setup it up (I still use Sublime Text), I do the writing on Obsidian.

What I write and see in Obsidian is good enough that I have just done away with looking at how the site looks after I change/add/edit the text. I sometimes do but just to check build and if the sitemaps are generated, etc. -- routine hygiene.

1. https://vitepress.dev

Consider Nuxt instead of Vuepress/Vitepress. If you want the built-in theme in Vitepress, it's great, but if you want to make your own, using Nuxt with the Content plugin is probably better. I found the strong separation between theme and content to be too great, and if I have a docs SSG site using Vitepress and a webapp SSR site using Nuxt, I can't share themes easily anyway.

At least that was my conclusion starting with Vitepress, and ending up with Nuxt 3.

https://nuxt.com/

https://vitepress.dev/ (they haven't decided if they are going to replace Vuepress or not: https://github.com/vuejs/vitepress/discussions/548)

Another option vitepress