https://github.com/0xsuk/agitcms
https://github.com/0xsuk/agitcms
headless-cms
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/0xsuk/agitcms
- Owner: 0xsuk
- License: mit
- Created: 2022-02-13T03:09:59.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-08-18T11:34:39.000Z (11 months ago)
- Last Synced: 2025-10-11T14:28:05.822Z (9 months ago)
- Language: TypeScript
- Homepage:
- Size: 18.8 MB
- Stars: 99
- Watchers: 1
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - 0xsuk/agitcms - A hackable headless CMS for markdown blogs (markdown)
README
/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.
[More screenshots](/github/showcase.md)
## Install
`npm install -g agitcms`
To start: `agitcms`
To change port: `AGIT_FRONTEND=3001 agitcms`
Node.js >= 18 is supported
## Idea
- it runs locally on browser
- it directly modifies the local markdown file
- you write javascript to tweak the editor
- you can use browser's feature (bookmarking, and all chrome extensions) because it runs on a browser.
- you can use shell scripts or cli program on the markdown files because it runs locally.
## 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
## Documents
[Quick Start](QuickStart.md)
[Using Markdown Editor](MarkdownEditor.md)
[Using Frontmatter Editor](FrontmatterEditor.md)
[Using Integrated Terminal](IntegratedTerminal.md)
[Using other components](OtherComponents.md)
[Settings](Settings.md)
[Plugins](Plugins.md)
[API reference](APIReference.md)
[Screenshots](/github/showcase.md)
[Explanation](/Explanation.md)