Skip to content

Commit bed2031

Browse files
Fix README.md formatting for proper rendering (#5)
- Fixed code block formatting with proper triple backticks and language specification - Fixed path formatting using backticks for inline code - Fixed project structure tree formatting - Ensures better rendering on GitHub Fixes #4
1 parent 13c4999 commit bed2031

1 file changed

Lines changed: 13 additions & 13 deletions

File tree

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ A clean, maintainable landing page for the Elmentor/DevOps Visions community bui
99
1010
## 📋 Quick Start
1111

12-
`ash
12+
```bash
1313
# Install dependencies
1414
npm install
1515

@@ -21,25 +21,25 @@ npm run build
2121

2222
# Preview production build
2323
npm run serve
24-
`
24+
```
2525

2626
## 🚀 Deployment
2727

2828
To deploy to GitHub Pages:
2929

30-
1. Update your GitHub username in \github-config.txt\
30+
1. Update your GitHub username in `github-config.txt`
3131
2. Run the deployment script:
32-
`ash
32+
```bash
3333
# PowerShell (recommended)
3434
./deploy.ps1
3535

3636
# Or using npm
3737
npm run deploy
38-
`
38+
```
3939

4040
## 🛠️ Project Structure
4141

42-
`
42+
```
4343
elmentor-landing-page-clean/
4444
├── dist/ # Build output
4545
├── docs/ # Documentation
@@ -56,7 +56,7 @@ elmentor-landing-page-clean/
5656
│ └── PULL_REQUEST_TEMPLATE/ # PR templates
5757
├── .temp/ # Untracked local development files (not in Git)
5858
└── src/ # Source code [DO NOT MODIFY]
59-
`
59+
```
6060

6161
## 🧩 Features
6262

@@ -70,28 +70,28 @@ elmentor-landing-page-clean/
7070

7171
For repository maintenance tasks:
7272

73-
`ash
73+
```bash
7474
./maintain.ps1
75-
`
75+
```
7676

7777
## 🔧 Development Utilities
7878

7979
For local development files that shouldn't be committed:
8080

81-
`ash
81+
```bash
8282
# Move or copy files to untracked .temp directory
8383
./move-to-temp.ps1
84-
`
84+
```
8585

86-
The \.temp\ directory is ignored by Git and provides a standardized location for:
86+
The `.temp` directory is ignored by Git and provides a standardized location for:
8787
- Development scripts
8888
- Documentation drafts
8989
- Temporary build outputs
9090
- Work-in-progress files
9191

9292
## 📚 Documentation
9393

94-
For detailed documentation, see the \docs\ directory:
94+
For detailed documentation, see the `docs` directory:
9595

9696
- [Deployment Guide](docs/deployment/README.md)
9797
- [Development Maintenance](docs/development/maintenance.md)

0 commit comments

Comments
 (0)