gridea README

The project's README from github.com/getgridea/gridea. As one markdown file: README.md.

Gridea

A static blog writing client

Download | Homepage

GitHub All Releases

English | Русский | 简体中文 | 繁體中文

CHANGELOG

👏 Welcome to use Gridea!

✍️ Gridea A static blog writing client. You can use it to record your life, mood, knowledge, notes and ideas...

Features👇

📝 Use the coolest Markdown editor to create quickly

🌉 Insert pictures and article cover charts anywhere in the article

🏷️ Label and group articles

📋 Customize menus and even create external link menus

💻 Use this client on Windows or MacOS or Linux

🌎 Use Github Pages or Coding Pages to show the world that more platforms will be supported in the future

💬 Simply configure and access the Gitalk or DisqusJS comment system

🗺️ Use simplified Chinese、traditional Chinese、 English、 Russian、 French

🌁 Use any default theme within the application or any third-party theme, free theme customization

🖥 Customize the source folder and synchronize multiple devices using OneDrive, iCloud, Dropbox, etc.

🌱 Of course Gridea is still very young and has many shortcomings, but please believe it will keep moving forward 🏃

In the future, it will surely become your inseparable partner

Give full play to your talents!

😘 Enjoy~

Development

If you want to contribute code, please check the Contribution Guide in advance.

$ # Node version > v10.0.0 is requied
$ git clone https://github.com/getgridea/gridea.git
$ cd gridea
$ yarn
$ yarn electron:serve
$ yarn electron:build

Contact

Telegram Channel | Telegram Group | QQ 1 Group: 970332209 | QQ 2 Group: 923131213 | Author Twitter: @EryouHao

Example Screenshots

Contributions

We welcome all contributions. You can submit any ideas as pull requests or as GitHub issues.

Donation

License

MIT. Copyright (c) 2020-2023 EryouHao

gridea (getgridea/gridea)

Searching Database…

10.2K ·GitHub
What is this?Gridea is a static blog writing client: a desktop app where you write posts in Markdown and publish them as a static blog — pitched for recording your life, mood, knowledge, notes and ideas.
So is this a website I log into, or a program I install on my computer?It's a desktop program built on Electron that you install on Windows, macOS or Linux. Your blog itself is generated as a static site, hosted on Github Pages or Coding Pages.
How do I get started with it?Download the installer for your system from the project homepage and run it — no command line needed. You write in the built-in Markdown editor, then connect Github Pages or Coding Pages in the app to publish.
Do I need anything else to get my blog online?Yes — a Github Pages or Coding Pages site to publish to, since Gridea generates a static site and pushes it there. The README says more hosting platforms will be supported in the future.
Are there any catches I should know about before diving in?The author admits Gridea is still young and has many shortcomings. Publishing currently supports only Github Pages and Coding Pages; other platforms are promised later.
What can I put into posts besides plain text?You can insert pictures and article cover images anywhere in a post, label and group articles, and customize your blog's menus — including menus that are just external links.
Can readers leave comments under my posts?Yes. Gridea supports the Gitalk and DisqusJS comment systems, and connecting one takes just a simple configuration in the app.
Can I change how my blog looks?Yes — use any of the default themes built into the app, pick a third-party theme, or customize a theme for free.
I write on more than one computer — how do I keep posts in sync?Point Gridea at a custom source folder and keep that folder in sync across devices with OneDrive, iCloud, Dropbox or similar services.
Creator
getgridea
Size
11.8 MB
Stars
10.2K
Age
8y
Commits · 90 Days