Skip to content

Commit 271dd7a

Browse files
author
Your Name
committed
docs: update README with custom domain setup instructions and fix markdown linting
1 parent 7d7ac73 commit 271dd7a

File tree

1 file changed

+56
-5
lines changed

1 file changed

+56
-5
lines changed

README.md

Lines changed: 56 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,42 @@ A beautiful, feature-rich markdown note-taking application with live preview, bu
1515
- **Local Storage** - Notes are automatically saved in your browser
1616
- **Syntax Highlighting** - Code blocks with syntax highlighting
1717

18+
## 🌐 Custom Domain Setup
19+
20+
To use your custom domain `thesolutiondesk.ca/tools/free/markdown`:
21+
22+
### 1. DNS Configuration
23+
24+
Add these records in your domain's DNS settings:
25+
26+
```dns
27+
# CNAME Record
28+
Name: tools.thesolutiondesk.ca
29+
Type: CNAME
30+
Value: thesolutiondeskandcompany.github.io
31+
TTL: Auto
32+
33+
# TXT Record (for GitHub verification)
34+
Name: _github-pages-challenge-thesolutiondesk
35+
Type: TXT
36+
Value: "<GitHub will provide this>"
37+
TTL: Auto
38+
```
39+
40+
### 2. GitHub Pages Settings
41+
42+
1. Go to your repository → Settings → Pages
43+
2. Under "Custom domain", enter: `thesolutiondesk.ca/tools/free/markdown`
44+
3. Check "Enforce HTTPS" when available
45+
46+
### 3. Verification
47+
48+
After DNS propagation (up to 48 hours), your app will be available at:
49+
50+
```
51+
https://thesolutiondesk.ca/tools/free/markdown
52+
```
53+
1854
## 🚀 Getting Started
1955

2056
### Prerequisites
@@ -72,17 +108,32 @@ A beautiful, feature-rich markdown note-taking application with live preview, bu
72108
- `Ctrl+D` - Toggle dark/light mode
73109
- `F11` - Toggle fullscreen mode
74110

75-
## 📦 Building for Production
111+
## 🚀 Deployment
76112

77-
To create a production build:
113+
### Local Development
114+
115+
```bash
116+
npm install
117+
npm run dev
118+
```
119+
120+
### Building for Production
78121

79122
```bash
80123
npm run build
81-
# or
82-
yarn build
83124
```
84125

85-
This will create a `dist` directory with the production-ready files.
126+
### Deploying to GitHub Pages
127+
128+
```bash
129+
# Build and deploy
130+
npm run deploy
131+
```
132+
133+
This will automatically:
134+
1. Build the production version
135+
2. Push to the `gh-pages` branch
136+
3. Make it available at your GitHub Pages URL
86137

87138
## 🤝 Contributing
88139

0 commit comments

Comments
 (0)