📝 OuMarkdown (OuMd)

OuMarkdown is a markdown-based note-sharing platform built with MDX, focused on speed, simplicity, and full customization.
It is designed as a personal tool for Ouji to easily publish and share notes directly from a GitHub repository.
All notes are stored in OuVault, a public GitHub repository where markdown files are written and managed locally using Obsidian.
Once the notes are pushed to GitHub, they become instantly accessible on the web and are rendered dynamically through the GitHub API. You can explore the website live at oumd.oujisan.my.id.

⚙️ Tech Stack

Language	Framework	Styling	Storage	Library	Deployment
TypeScript	Next.js	Tailwind CSS	GitHub	MDX	Vercel

💡 Inspiration

OuMarkdown was inspired by enscribe.dev, a beautifully crafted markdown-based notebook created by @jktrn.
The minimalist design, smooth reading experience, and clever use of GitHub as a content source gave me the foundation and motivation to build a version tailored to my own workflow and preferences.

Note

This is my first time building something with TypeScript and Next.js, so things might not be perfect just yet — still figuring things out as I go. I built this with a lot of help from AI tools along the way, which made the learning process much smoother. Always happy to hear thoughts or ideas for improvement!

✨ Features

🌍 1. Public Access & Easy Sharing

Every note published through OuMarkdown is publicly accessible. Visitors — or Ouji himself — can simply copy a link to instantly share any markdown file as a live, readable web page.

🗂️ 2. Automatic Category Icons

Each markdown file begins with a header in the format # [{category}] {title}, OuMarkdown automatically parses this and displays a unique icon based on the category. If a matching icon is found in the ./public/category directory, it will be displayed. Otherwise, a default icon will be used. Currently, more than 50 categories are supported.

🔗 3. Optimized GitHub API Usage

By leveraging GitHub’s REST API and using a fine-grained personal access token, OuMarkdown supports up to 5000 requests per hour, ensuring fast and uninterrupted access even during high-traffic usage.

⬇️ 4. Markdown File Download

Users can easily download any markdown file via a one-click action button using GitHub’s raw content endpoint: https://raw.githubusercontent.com/... . This makes it convenient to reuse or save notes locally.

🔎 5. Intelligent Search & Filtering

A smart search system helps users find notes quickly and intuitively. To filter by category, simply prefix the keyword with #, for example: #ai to find notes in the AI category. Search results are fast, structured, and relevant.

🔮 Future Plans

📑 1. Automatic Table of Contents (ToC)

A table of contents will be generated for each markdown note to improve navigation. All headers (#, ##, ###, etc.) inside the markdown will be parsed and displayed as clickable links, allowing users to jump directly to any section in the note. This will be especially helpful for long-form content or technical documentation.

✍️ 2. Create, Update, and Delete Notes from the Web

OuMarkdown will soon support creating, editing, and deleting markdown notes directly from the web interface. These features will be protected by password authentication, ensuring only authorized access. The editing experience will include a live markdown preview, offering a writing workflow similar to Obsidian or VS Code, all within the browser.

Category / Topic:

Ai	Cloud	Database	Git	Laravel	Network	QnA	Troubleshoot	Anime	Code
ExpressJS	GitHub	Linux	Next.js	React	C#	Typescript	Extension	HTML	Logbook
Note	Review	Video	Assembly	CSS	Firebase	Idea	Matkul	Penetration	Script
Vue	Blockchain	CTF	Fix	JavaScript	MD	PHP	SQLite	Web	Box
Dart	Flutter	Kotlin	Music	PostgreSQL	Tailwind	C++	Game	Language	MySQL
Python	Terminal	Apache	Azure	Docker	Dotnet	Godot	Kubernetes	Neon	Nginx
Notion	Obsidian	Postman	Railway	Render	Supabase	Swagger	Unity	Vercel	Data