agitcms
agitcms copied to clipboard
0xsuk
Headless CMS for developers
Agit CMS
A hackable headless CMS for markdown blogs
/eɪdʒɪt/
Agit CMS is a simple web frontend interface that utilizes filesystem to manage markdown/media contents. Built for markdown-based static site generators, like Hugo and Jekyll.
Write markdown blog posts the hackable way, get rid of your itch points.
More screenshots
Install
npm install -g agitcms
To start: agitcms
To change port: AGIT_FRONTEND=3001 agitcms
Node.js >= 18 is supported
Features
- vertical split style markdown editor
- type-aware frontmatter editor
- custom editor snippet/toolbar/keymap
- custom frontmatter language(yaml/toml) & delimiters
- Integrated Terminal
- mathjax rendering:
$$ E = mc^2 $$
$$ Agit = wonderful $$
- image pasting into the editor
Agit CMS tries to be a hackable headless CMS for developers.
Comparison with Netlify CMS
| Agit CMS | Netlify CMS | |
|---|---|---|
| How/Where does the CMS run? | You start agitcms when you want to from terminal. Then it runs on your computer. | It always lives in website's /admin path (which heavily relies on the strength of your password) |
| Who is the CMS for? | Developers | Writers |
| Installation | Dead simple (npm i) | Pretty complicated |
| How are changes committed to a remote git repository? | Agit CMS is a simple CMS that reads from and writes to your filesystem. So you simply use integrated terminal or whatever to run git command. | Push Publish button |
| Can you paste(Control+v/Command+v) an image into the markdown editor? | O | X |
| Can the markdown editor preview mathjax? | O | △ (requires additional setup) |
| How do I preview a post real-time in my actual website? | Run a preview command specific to your static site generator in integrated terminal | You can't. |
| How customizable is the markdown editor? | O | △ (You can customize for sure by including |
| Rich Text Editing? | X | O |
| For multiple editors? | X | O |
| Looks good? | O (Colors picked from github site) | X (100% personal opinion) |
Documents
Quick Start
Using Markdown Editor
Using Frontmatter Editor
Using Integrated Terminal
Using other components
Settings
Plugins
API reference
Screenshots
Explanation
Bugs and Questions
If you want to report a bug or have a question, create a new issue. Don't forget to label it!
Development
Agit CMS is built with React.js, Typescript, webpack, Material UI, and CodeMirror
environment setup
Install: git clone [email protected]:0xsuk/agitcms.git && npm i
Start: npm run dev
changelog
From version 2.0.0, Agit CMS became a web interface instead of a desktop app. This way you can use your favorite chrome extension like Grammarly.
info
Agit CMS is still maintained, but is not actively developed. The latest version is mature enough for me.
TODO
- [ ] markdown editor - custom markdown rendering
- [ ] markdown editor - auto saving config
- [ ] markdown editor - Table of contents
- [ ] integrated terminal - zsh annoys me.
- [ ] Media tab - drag and drop image
0xsuk