Skip to content

Commit bb91537

Browse files
authored
docs: update README formatting and headings
1 parent 248ee0b commit bb91537

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# 🧠 RxDev Man
1+
# RxDev Man
22

33
> **The Developer's Living Knowledge Base.**
44
> A high-performance, interactive knowledge graph built for modern software engineers.
55
6-
🌐 **[Live Demo: rxdevman.com](https://www.rxdevman.com/)**
6+
**[Live Demo: rxdevman.com](https://www.rxdevman.com/)**
77

88
![Astro](https://img.shields.io/badge/Astro-5.0-FF5D01?style=flat&logo=astro)
99
![TypeScript](https://img.shields.io/badge/TypeScript-5.0-3178C6?style=flat&logo=typescript)
@@ -15,9 +15,9 @@
1515

1616
---
1717

18-
## 🔑 Key Features
18+
## Key Features
1919

20-
### 📚 Rich Content Experience
20+
### Rich Content Experience
2121

2222
- **MDX-Powered**: Author content in Markdown with the power of embedded components.
2323
- **Interactive Blocks**:
@@ -27,20 +27,20 @@
2727
- `<GitCommand />`: Copy-paste friendly terminal snippets.
2828
- **Syntax Highlighting**: Beautiful code blocks powered by Shiki (GitHub Dark theme).
2929

30-
### Performance & Architecture
30+
### Performance & Architecture
3131

3232
- **Zero-JS by Default**: HTML-first rendering for optimal SEO and load times.
3333
- **Hybrid Rendering**: Static Site Generation (SSG) for content, with Server-Side Rendering (SSR) capabilities for dynamic features.
3434
- **Client-Side Search**: Instant, typo-tolerant search using **Pagefind**.
3535

36-
### 📊 Analytics & Data
36+
### Analytics & Data
3737

3838
- **Real-Time View Counts**: Integrated with **Supabase** to track article engagement.
3939
- **Type-Safe Content**: Validated frontmatter schemas using **Zod**.
4040

4141
---
4242

43-
## 🛠️ Tech Stack
43+
## Tech Stack
4444

4545
| Category | Technology | Usage |
4646
| ------------ | --------------------------------------------- | --------------------------- |
@@ -55,7 +55,7 @@
5555

5656
---
5757

58-
## 📂 Project Structure
58+
## Project Structure
5959

6060
```text
6161
/
@@ -80,7 +80,7 @@
8080

8181
---
8282

83-
## 🧞 Getting Started
83+
## Getting Started
8484

8585
Follow these steps to set up the project locally.
8686

@@ -149,7 +149,7 @@ This command will:
149149

150150
---
151151

152-
## 🎯 Roadmap
152+
## Roadmap
153153

154154
- [ ] **Dark Mode Toggle**: User-selectable theme preferences
155155
- [ ] **Tag System**: Filter articles by technology/topic
@@ -161,7 +161,7 @@ This command will:
161161

162162
---
163163

164-
## 📝 Contributing
164+
## Contributing
165165

166166
We welcome contributions from the community!
167167

@@ -173,7 +173,7 @@ We welcome contributions from the community!
173173

174174
---
175175

176-
## 📜 License
176+
## License
177177

178178
This project is open source and available under the [MIT License](LICENSE).
179179

0 commit comments

Comments
 (0)