Skip to content

Commit d7bf42a

Browse files
authored
Revise README for improved content and formatting
Updated README to enhance clarity and structure.
1 parent ccb1880 commit d7bf42a

1 file changed

Lines changed: 23 additions & 2 deletions

File tree

README.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,37 @@
11
# Neo-Brutalist Blog Editor for Github
22

3+
A **no-CMS**, no-lock-in **blog editor** that publishes directly to your **GitHub** repo.
4+
35
<img src="https://raw.githubusercontent.com/monapdx/publish-to-github/refs/heads/main/neo-butalist-blog-editor-github.png">
46

5-
A small, **browser-only app** for drafting **blog posts** and publishing them as **HTML files** to a **GitHub repository** via the [Contents API](https://docs.github.com/en/rest/repos/contents). Think of it as a personal utility: write in a rich editor or raw HTML, keep drafts locally, and push files into a folder you choose (for example `blog/`).
7+
Publishes posts as **HTML files** to a **GitHub repository** via the [Contents API](https://docs.github.com/en/rest/repos/contents). Think of it as a personal utility: write in a rich editor or raw HTML, keep drafts locally, and push files into a folder you choose (for example `blog/`).
68

79
## Features
810

9-
### Editing
11+
### Toolbar
1012

1113
<img src="https://raw.githubusercontent.com/monapdx/publish-to-github/refs/heads/main/toolbar.png">
1214

1315
- **Visual mode:** [TipTap](https://tiptap.dev/) v3 (ProseMirror) with headings (H1–H3), paragraph, bold, italic, underline, bullet and ordered lists, blockquote, horizontal rule, links, and undo/redo. **Ctrl/Cmd+S** saves the current draft (same as **Save draft**).
1416

1517
- **Code mode:** plain `textarea` for the post body HTML.
1618

19+
<img src="https://raw.githubusercontent.com/monapdx/publish-to-github/refs/heads/main/visual-code-editors.gif" width="732">
20+
1721
- **Tables:** insert a sized table (header row), then add/remove rows and columns or remove the whole table while the cursor is inside the table.
1822

23+
<img src="https://raw.githubusercontent.com/monapdx/publish-to-github/refs/heads/main/insert-table.png">
24+
25+
- **Upload Media:**
26+
27+
<img src="https://raw.githubusercontent.com/monapdx/publish-to-github/refs/heads/main/upload-media.png">
28+
1929
- **Code snippets:** insert a multiline snippet from a dialog; optional language label becomes a `language-*` class on `<code>`. In Visual mode the block is styled with decorative triple-backtick lines; exported HTML is a normal `<pre><code>` block.
2030

2131
- **Images:** paste a URL or upload a file (embedded as a data URL in the draft). Alt text, width, height, and alignment classes (`blog-image align-*`) are supported.
2232

33+
<img src="https://raw.githubusercontent.com/monapdx/publish-to-github/refs/heads/main/insert-image.png">
34+
2335
### Sidebar
2436

2537
- Switch between **Drafts** (local) and **Published** (files in your configured **Posts folder** on GitHub).
@@ -60,3 +72,12 @@ Use a **fine-grained token** that can **read** repository contents (to list and
6072
- `npm run build` — production build
6173
- `npm run preview` — preview the production build
6274
- `npm run lint` — ESLint
75+
76+
## Why this exists
77+
78+
- No databases
79+
- No dashboards
80+
- No subscriptions
81+
- Just files in your repo
82+
83+
**Write → Save locally → Publish to GitHub**

0 commit comments

Comments
 (0)