Skip to content

Commit aebeb03

Browse files
Create README.md
1 parent b0b43ca commit aebeb03

File tree

1 file changed

+92
-0
lines changed

1 file changed

+92
-0
lines changed

README.md

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
📘 My Notes Website
2+
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
26+
My Notes Website/
27+
│ index.html # Homepage (list of courses)
28+
29+
├───assets
30+
│ ├───css
31+
│ │ general.css # General reusable styles
32+
│ │ notion.css # Notion-like styling for notes
33+
│ │ styles.css # Main stylesheet
34+
│ │
35+
│ ├───Icons # Icons for courses and navigation
36+
│ │ arrow_right.png
37+
│ │ javascript.png
38+
│ │ monitor.png
39+
│ │ open link.png
40+
│ │ pen.png
41+
│ │
42+
│ ├───Images
43+
│ │ └───Courses Banner # Banner images for courses
44+
│ │ JavaScript.jpg
45+
│ │
46+
│ └───js
47+
│ generateBreadcrumb.js # Dynamically generates breadcrumbs
48+
│ script.js # General scripts
49+
50+
└───Courses
51+
│ index.html # Courses page
52+
53+
├───HTML and CSS # Placeholder for HTML & CSS notes
54+
55+
└───JavaScript
56+
│ index.html
57+
58+
└───JavaScript Fundamentals Part - 1
59+
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.

0 commit comments

Comments
 (0)