Skip to content

Commit 7f9c9cc

Browse files
author
Your Name
committed
docs: update README with better formatting and custom domain instructions
1 parent cbd9334 commit 7f9c9cc

File tree

1 file changed

+31
-14
lines changed

1 file changed

+31
-14
lines changed

README.md

Lines changed: 31 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,20 @@
1-
# Markdown Notes
1+
# 📝 Markdown Notes
22

33
A beautiful, feature-rich markdown note-taking application with live preview, built with React and Tailwind CSS.
44

5-
![Markdown Notes Screenshot](https://via.placeholder.com/1200x800/1e293b/ffffff?text=Markdown+Notes+Screenshot)
5+
## 🚀 Live Demo
6+
7+
Try it out: [https://thesolutiondeskandcompany.github.io/markdown-notes/](https://thesolutiondeskandcompany.github.io/markdown-notes/)
8+
9+
```text
10+
📝 Markdown Editor (Left) | 👁️ Live Preview (Right)
11+
----------------------------------------------
12+
| # Welcome! | # Welcome! |
13+
| Start writing... | Start writing... |
14+
| - Lists | • Lists |
15+
| `code` | code (syntax) |
16+
| **bold** | **bold** |
17+
```
618

719
## ✨ Features
820

@@ -17,25 +29,30 @@ A beautiful, feature-rich markdown note-taking application with live preview, bu
1729

1830
## 🌐 Deployment
1931

20-
Your app is deployed to GitHub Pages at:
32+
### Using GitHub Pages
2133

22-
```
23-
https://thesolutiondeskandcompany.github.io/markdown-notes/
24-
```
34+
The app is automatically deployed to GitHub Pages at:
35+
[thesolutiondeskandcompany.github.io/markdown-notes](https://thesolutiondeskandcompany.github.io/markdown-notes/)
2536

26-
### Setting Up a Custom Domain (Optional)
37+
### Custom Domain Setup
2738

28-
If you want to use a custom domain like `markdown.thesolutiondesk.ca`:
39+
To use a custom domain (e.g., `markdown.thesolutiondesk.ca`):
2940

30-
1. **Update DNS Settings**:
31-
- Go to your domain registrar
32-
- Add a CNAME record pointing to `thesolutiondeskandcompany.github.io`
41+
1. **Add a CNAME record** in your domain's DNS settings:
42+
```text
43+
Type: CNAME
44+
Name: markdown
45+
Value: thesolutiondeskandcompany.github.io
46+
TTL: Auto
47+
```
3348

3449
2. **Configure GitHub Pages**:
3550
- Go to your repository → Settings → Pages
36-
- Under "Custom domain", enter your domain (e.g., `markdown.thesolutiondesk.ca`)
37-
- Click "Save"
38-
- Once verified, check "Enforce HTTPS"
51+
- Under "Custom domain", enter your domain
52+
- Save and wait for DNS verification
53+
- Once verified, enable "Enforce HTTPS"
54+
55+
> Note: DNS changes may take up to 24 hours to propagate globally.
3956
4057
## 🚀 Getting Started
4158

0 commit comments

Comments
 (0)