Skip to content
Get packs

Guide · Open source

How to use Gridea: install, write posts and publish a static blog

Updated · written with AI from the project's own documentation and checked against our catalogue data

Gridea is a desktop app for writing a static blog. You write posts in a Markdown editor, and it generates a website of plain static files that you host yourself, with no database or server to run. This guide covers installing Gridea, writing and organising posts, and the options the project describes for publishing and comments.

Grideagetgridea/gridea · ★ 10.2k · MIT

Quick start

  1. 1Download the release. Go to the Gridea releases page on GitHub and download the prebuilt build for your operating system.
  2. 2Install and open Gridea. Install the app and launch it on Windows, macOS or Linux.
  3. 3Write a post. Create an article in the Markdown editor and add pictures or a cover image where you need them.
  4. 4Organise your articles. Add labels and group your articles, and customise menus if you want external links.
  5. 5Choose a theme. Pick one of the default themes or a third-party theme, and adjust it to your liking.
  6. 6Publish the static site. Host the generated static files on a platform such as GitHub Pages or Coding Pages.

What Gridea is and who it suits

Gridea is a static blog writing client. It is built with Electron, Vue and TypeScript and runs on Windows, macOS and Linux. The output is a static website, so the blog does not need a database or a running server.

The project's README points to bloggers who want to own their content as plain static files, and to people who prefer writing Markdown in a desktop app.

Install Gridea on Windows, macOS or Linux

Gridea is installed by downloading a prebuilt release. The README links to the releases page on GitHub, where you can pick the build for your system. The README does not list any prerequisites for this method.

  • Open the releases page: https://github.com/getgridea/gridea/releases
  • Download the release for Windows, macOS or Linux
  • Install and open the app

Write and organise posts

Gridea includes a Markdown editor for writing articles. You can insert pictures anywhere in an article and set an article cover image. Articles can be labelled and grouped, which helps you organise a growing blog.

You can also customise the menus, including adding external link menus.

  • Write posts in Markdown
  • Insert pictures and article cover images
  • Add labels and group articles
  • Add custom menus or external link menus

Pick a theme and set your language

Gridea can use any of its default themes or a third-party theme, and the README says the theme can be customised freely. The app is available in simplified Chinese, traditional Chinese, English, Russian and French.

Publish to a static host such as GitHub Pages

The README names GitHub Pages and Coding Pages as places to host the generated site. Because the output is static files, any static host can serve it. The README does not give step-by-step publishing instructions, so check the project homepage or wiki for the current process.

You can also set the source folder and sync it across devices with OneDrive, iCloud, Dropbox or similar services, as the README describes.

Add comments with Gitalk or DisqusJS

The README says you can configure the Gitalk or DisqusJS comment system for your blog. Both are third-party services that the README links to, and the README does not describe the setup steps in detail.

Build Gridea from source (for contributors)

If you want to contribute code, the README asks you to read the Contribution Guide first. It lists Node version above v10.0.0 as required and shows the development commands below.

$ git clone https://github.com/getgridea/gridea.git $ cd gridea $ yarn $ yarn electron:serve $ yarn electron:build

What people use it for

  • Keeping a personal blog of notes, ideas and mood logs as plain Markdown-based static files
  • Writing posts offline in a desktop editor and publishing them to GitHub Pages
  • Keeping the blog source folder in sync across devices with OneDrive, iCloud or Dropbox
  • Adding Gitalk or DisqusJS comments to a static blog

Frequently asked questions

Is Gridea free?

Gridea is released under the MIT licence, according to the README's licence section. The README does not mention paid plans.

How do I install Gridea?

Download a prebuilt release from the GitHub releases page at https://github.com/getgridea/gridea/releases. The README lists no prerequisites for this method.

What operating systems does Gridea run on?

The README lists Windows, macOS and Linux. It does not list mobile or web versions.

Does Gridea need a database or server?

No. Gridea generates a static website, which you host on a static platform such as GitHub Pages.

Can I add comments to a Gridea blog?

Yes. The README says you can configure Gitalk or DisqusJS. These are third-party comment systems.

How does Gridea compare to Hugo, Jekyll, Hexo or Typora?

Hugo, Jekyll and Hexo are static site generators that are usually driven from the command line and text files. Typora is a Markdown editor. Gridea combines a desktop Markdown editor with static site generation in one app, though the README does not compare features directly.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

Gridea suits bloggers who want a desktop Markdown editor and plain static files they can host themselves. It is a poor fit if you want a hosted blog with no setup, a mobile or web editor, or real-time collaboration, since the README mentions none of these.

Install options & downloads