saifisvibin commited on
Commit
e48ccee
Β·
verified Β·
1 Parent(s): 9218ec0

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +47 -162
README.md CHANGED
@@ -1,162 +1,47 @@
1
- ---
2
- title: Machine Learning Systems
3
- emoji: πŸ“š
4
- colorFrom: purple
5
- colorTo: blue
6
- sdk: static
7
- pinned: false
8
- ---
9
-
10
- # Machine Learning Systems PDF Viewer
11
-
12
- A stunning, modern web application for viewing the Machine Learning Systems PDF. Built with vanilla JavaScript, HTML, and CSS, featuring a premium dark mode design with glassmorphism effects.
13
-
14
- ## ✨ Features
15
-
16
- - πŸ“„ **PDF.js Integration** - Smooth in-browser PDF viewing
17
- - 🎨 **Premium Design** - Dark mode with vibrant gradients and glassmorphism
18
- - πŸ” **Search Functionality** - Find text across all pages
19
- - ⌨️ **Keyboard Shortcuts** - Navigate efficiently with hotkeys
20
- - πŸ“± **Fully Responsive** - Works beautifully on all devices
21
- - 🎯 **Page Thumbnails** - Quick navigation with visual previews
22
- - πŸ”Ž **Zoom Controls** - Multiple zoom options including fit-to-width
23
- - πŸ–ΌοΈ **Fullscreen Mode** - Distraction-free reading experience
24
-
25
- ## πŸš€ Deployment to Hugging Face Spaces
26
-
27
- ### Step 1: Create a New Space
28
-
29
- 1. Go to [Hugging Face](https://huggingface.co/) and sign in
30
- 2. Click on your profile β†’ **New Space**
31
- 3. Choose:
32
- - **Space name**: `ml-systems-pdf-viewer` (or your preferred name)
33
- - **License**: Choose your preferred license
34
- - **Space SDK**: Select **Static**
35
- - **Visibility**: Public or Private
36
-
37
- ### Step 2: Upload Files
38
-
39
- You can upload files either through the web interface or using Git:
40
-
41
- #### Option A: Web Interface
42
- 1. In your Space, click **Files** β†’ **Add file** β†’ **Upload files**
43
- 2. Upload these files:
44
- - `index.html`
45
- - `styles.css`
46
- - `script.js`
47
- - `Machine-Learning-Systems.pdf`
48
- - `README.md` (this file)
49
-
50
- #### Option B: Git (Recommended)
51
- ```bash
52
- # Clone your Space repository
53
- git clone https://huggingface.co/spaces/YOUR_USERNAME/YOUR_SPACE_NAME
54
- cd YOUR_SPACE_NAME
55
-
56
- # Copy all files
57
- cp index.html styles.css script.js Machine-Learning-Systems.pdf README.md ./
58
-
59
- # Commit and push
60
- git add .
61
- git commit -m "Initial commit: PDF viewer application"
62
- git push
63
- ```
64
-
65
- ### Step 3: Configure Custom Domain
66
-
67
- 1. Go to your Space settings
68
- 2. Navigate to **Settings** β†’ **Domains**
69
- 3. Click **Add a domain**
70
- 4. Follow the instructions to:
71
- - Add your custom domain (e.g., `ml-systems.yourdomain.com`)
72
- - Update your DNS records with the provided CNAME
73
- - Wait for DNS propagation (can take up to 48 hours)
74
-
75
- **DNS Configuration Example:**
76
- ```
77
- Type: CNAME
78
- Name: ml-systems (or your subdomain)
79
- Value: spaces.huggingface.co
80
- TTL: 3600
81
- ```
82
-
83
- 5. Once DNS is propagated, enable SSL certificate (automatic via Let's Encrypt)
84
-
85
- ## πŸ’» Local Development
86
-
87
- To run this project locally:
88
-
89
- 1. **Clone or download** this repository
90
- 2. **Ensure all files are in the same directory**:
91
- - `index.html`
92
- - `styles.css`
93
- - `script.js`
94
- - `Machine-Learning-Systems.pdf`
95
- 3. **Open `index.html`** in a modern web browser (Chrome, Firefox, Safari, or Edge)
96
-
97
- > **Note**: For the best experience, serve the files through a local web server rather than opening the HTML file directly. You can use:
98
- > - Python: `python -m http.server 8000`
99
- > - Node.js: `npx http-server`
100
- > - VS Code: Use the Live Server extension
101
-
102
- ## ⌨️ Keyboard Shortcuts
103
-
104
- - `←` / `β†’` - Navigate between pages
105
- - `↑` / `↓` - Navigate between pages (alternative)
106
- - `+` / `-` - Zoom in/out
107
- - `Ctrl+F` - Open search
108
- - `F` - Toggle fullscreen
109
- - `Ctrl+Wheel` - Zoom with mouse wheel
110
-
111
- ## 🎨 Design Features
112
-
113
- - **Glassmorphism UI** - Frosted glass effect with backdrop blur
114
- - **Vibrant Gradients** - Purple, blue, and cyan color scheme
115
- - **Smooth Animations** - Micro-interactions for better UX
116
- - **Responsive Layout** - Adapts to mobile, tablet, and desktop
117
- - **Dark Mode** - Eye-friendly dark theme optimized for reading
118
-
119
- ## πŸ”§ Customization
120
-
121
- ### Change Colors
122
- Edit the CSS custom properties in `styles.css`:
123
- ```css
124
- :root {
125
- --color-accent-primary: #a855f7; /* Purple */
126
- --color-accent-secondary: #3b82f6; /* Blue */
127
- --color-accent-tertiary: #06b6d4; /* Cyan */
128
- }
129
- ```
130
-
131
- ### Default Zoom Level
132
- Edit `script.js`:
133
- ```javascript
134
- const state = {
135
- scale: 1.5, // Change this value (1.0 = 100%)
136
- // ...
137
- };
138
- ```
139
-
140
- ## πŸ“¦ Dependencies
141
-
142
- - [PDF.js](https://mozilla.github.io/pdf.js/) v3.11.174 (loaded via CDN)
143
- - [Google Fonts](https://fonts.google.com/) - Inter & Fira Code
144
-
145
- ## 🌐 Browser Support
146
-
147
- - Chrome/Edge (latest)
148
- - Firefox (latest)
149
- - Safari (latest)
150
- - Mobile browsers (iOS Safari, Chrome Mobile)
151
-
152
- ## πŸ“ License
153
-
154
- This PDF viewer application is provided as-is. The PDF content may have its own license.
155
-
156
- ## 🀝 Contributing
157
-
158
- Feel free to fork this project and customize it for your needs!
159
-
160
- ---
161
-
162
- Built with ❀️ for the Machine Learning community
 
1
+ ---
2
+ title: Machine Learning Systems
3
+ emoji: πŸ“š
4
+ colorFrom: purple
5
+ colorTo: blue
6
+ sdk: static
7
+ app_file: index.html
8
+ pinned: false
9
+ ---
10
+
11
+ # Machine Learning Systems PDF Viewer
12
+
13
+ A modern web app for viewing the *Machine Learning Systems* PDF in the browser.
14
+ Built with plain HTML, CSS, and JavaScript.
15
+
16
+ ## Features
17
+
18
+ - In-browser PDF viewing (PDF.js)
19
+ - Dark mode UI
20
+ - Page navigation
21
+ - Zoom controls
22
+ - Search across pages
23
+ - Keyboard shortcuts
24
+ - Responsive layout
25
+ - Fullscreen mode
26
+
27
+ ## Files
28
+
29
+ The project uses these files at the repository root:
30
+
31
+ - `index.html`
32
+ - `styles.css`
33
+ - `script.js`
34
+ - `Machine-Learning-Systems.pdf`
35
+
36
+ ## Tech Stack
37
+
38
+ - HTML
39
+ - CSS
40
+ - JavaScript
41
+ - PDF.js (CDN)
42
+
43
+ ## Notes
44
+
45
+ - This is a **Static Hugging Face Space**
46
+ - No backend or Python code is used
47
+ - All logic runs in the browser