Skip to content

Commit ae3cad9

Browse files
Update README.md
1 parent 330d348 commit ae3cad9

1 file changed

Lines changed: 38 additions & 56 deletions

File tree

README.md

Lines changed: 38 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,21 @@
11
# 📘 My Notes Website
22

3-
A personal website to organize and share notes from different courses in a clean and structured way. Each course has its own section with HTML pages and Markdown notes for easy access and readability.
4-
5-
🚀 Features
6-
7-
📂 Well-structured notes organized by course
8-
9-
🖼️ Course cards with banners and icons
10-
11-
📑 Breadcrumb navigation for better orientation
12-
13-
📝 Mix of HTML pages and Markdown files for notes
14-
15-
🎨 Responsive layout with custom CSS
16-
17-
🛠️ Tech Stack
18-
19-
HTML5 – page structure
20-
21-
CSS3 – styling (with modular files)
22-
23-
JavaScript (Vanilla) – interactivity and breadcrumb generation
24-
25-
📂 Project Structure
3+
A personal website to organize and share notes from different courses in a clean and structured way. Each course has its own section with HTML pages and Markdown notes for easy access and readability.
4+
5+
## 🚀 Features
6+
- 📂 Well-structured notes organized by course
7+
- 🖼️ Course cards with banners and icons
8+
- 📑 Breadcrumb navigation for better orientation
9+
- 📝 Mix of **HTML pages** and **Markdown files** for notes
10+
- 🎨 Responsive layout with custom CSS
11+
12+
## 🛠️ Tech Stack
13+
- **HTML5** – page structure
14+
- **CSS3** – styling (with modular files)
15+
- **JavaScript (Vanilla)** – interactivity and breadcrumb generation
16+
17+
## 📂 Project Structure
18+
```
2619
My Notes Website/
2720
│ index.html # Homepage (list of courses)
2821
@@ -57,36 +50,25 @@ My Notes Website/
5750
5851
└───JavaScript Fundamentals Part - 1
5952
functions.html
60-
61-
📖 How to Use
62-
63-
Clone this repository:
64-
65-
git clone https://github.com/khalidrahmanhanify/my-notes-website.git
66-
67-
68-
Open index.html in your browser to view the homepage.
69-
70-
Navigate through the course cards to view notes.
71-
72-
To add a new course:
73-
74-
Create a new folder inside Courses/.
75-
76-
Add an index.html file (and optionally .md files for notes).
77-
78-
Add a course card in the homepage (index.html).
79-
80-
📌 Future Enhancements
81-
82-
🔍 Global search across notes
83-
84-
📊 Progress tracking with percentage completion
85-
86-
🌗 Dark/Light mode toggle
87-
88-
🌍 Deployment with GitHub Pages
89-
90-
📜 License
91-
92-
This project is for personal and educational use. You’re welcome to fork and customize it for your own learning notes.
53+
```
54+
55+
## 📖 How to Use
56+
1. Clone this repository:
57+
```bash
58+
git clone https://github.com/khalidrahmanhanify/my-notes-website.git
59+
```
60+
2. Open `index.html` in your browser to view the homepage.
61+
3. Navigate through the course cards to view notes.
62+
4. To add a new course:
63+
- Create a new folder inside `Courses/`.
64+
- Add an `index.html` file (and optionally `.md` files for notes).
65+
- Add a course card in the homepage (`index.html`).
66+
67+
## 📌 Future Enhancements
68+
- 🔍 Global search across notes
69+
- 📊 Progress tracking with percentage completion
70+
- 🌗 Dark/Light mode toggle
71+
- 🌍 Deployment with GitHub Pages
72+
73+
## 📜 License
74+
This project is for **personal and educational use**. You’re welcome to fork and customize it for your own learning notes.

0 commit comments

Comments
 (0)