A deployable markdown editor that connects with your self hosted files and lets you edit in a beautiful interface
docs: updates docs
+13
-23
+10
-19
README.md
+10
-19
README.md
···
4
4
5
5
## Features
6
6
7
-
- **🎨 Beautiful WYSIWYG Editor** - Rich text editing powered by TipTap with markdown support
8
-
- **📝 Frontmatter Support** - Edit YAML frontmatter metadata alongside your content
9
-
- **💾 Auto-save** - Changes are automatically saved as drafts every 2 seconds
10
-
- **🔄 Git Integration** - Automatic branching, commits, and pull request creation
11
-
- **🔐 GitHub OAuth** - Secure authentication with your GitHub account
12
-
- **📂 Multi-repo Support** - Work with multiple repositories and folder structures
13
-
- **⚡ Fast & Lightweight** - Built with modern technologies for optimal performance
14
-
- **🐳 Docker Ready** - Easy deployment with Docker and docker-compose
7
+
- **Beautiful WYSIWYG Editor** - Rich text editing powered by TipTap with markdown support
8
+
- **Frontmatter Support** - Edit YAML frontmatter metadata alongside your content
9
+
- **Auto-save** - Changes are automatically saved as drafts every 2 seconds
10
+
- **Git Integration** - Automatic branching, commits, and pull request creation
11
+
- **GitHub OAuth** - Secure authentication with your GitHub account
12
+
- **Multi-repo Support** - Work with multiple repositories and folder structures
13
+
- **Fast & Lightweight** - Built with modern technologies for optimal performance
14
+
- **Docker Ready** - Easy deployment with Docker and docker-compose
15
15
16
16
## Quick Start
17
17
···
25
25
1. Clone the repository:
26
26
27
27
```bash
28
-
git clone https://github.com/yourusername/markedit.git
28
+
git clone https://tangled.org/usaa.ma/markedit
29
29
cd markedit
30
30
```
31
31
···
174
174
make shell-fe # Access frontend shell
175
175
```
176
176
177
-
## Design Philosophy
178
-
179
-
MarkEdit features a distinctive **brutalist/editorial aesthetic**:
180
-
181
-
- **Typography**: Archivo Black for headings, Crimson Pro for body text
182
-
- **Colors**: Amber/orange accents (#d97706) with strong black borders
183
-
- **Style**: Bold 2px borders, grain texture backgrounds, no gradients
184
-
- **UX**: Clear, direct interactions with immediate feedback
185
-
186
177
## Security
187
178
188
179
- OAuth tokens are securely stored and never exposed to the frontend
···
202
193
203
194
For detailed setup instructions, see [SETUP.md](./SETUP.md)
204
195
205
-
For issues and feature requests, please use [GitHub Issues](https://github.com/yourusername/markedit/issues)
196
+
For issues and feature requests, please use [Tangled Issues](https://tangled.org/usaa.ma/markedit/issues)
+3
-4
SETUP.md
+3
-4
SETUP.md
···
58
58
### 1. Clone Repository
59
59
60
60
```bash
61
-
git clone https://github.com/yourusername/markedit.git
61
+
git clone https://tangled.org/usaa.ma/markedit
62
62
cd markedit
63
63
```
64
64
···
263
263
264
264
```bash
265
265
# Clone repository
266
-
git clone https://github.com/yourusername/markedit.git .
266
+
git clone https://tangled.org/usaa.ma/markedit
267
267
268
268
# Configure environment
269
269
cp .env.example .env
···
525
525
## Support
526
526
527
527
- **Documentation**: [README.md](./README.md)
528
-
- **Issues**: [GitHub Issues](https://github.com/yourusername/markedit/issues)
529
-
- **Discussions**: [GitHub Discussions](https://github.com/yourusername/markedit/discussions)
528
+
- **Issues**: [Tangled Issues](https://tangled.org/usaa.ma/markedit/issues)
530
529
531
530
## Next Steps
532
531