Skip to content
This repository was archived by the owner on Oct 19, 2025. It is now read-only.

Commit c6f4b66

Browse files
authored
Update README.md
1 parent e11b829 commit c6f4b66

File tree

1 file changed

+180
-59
lines changed

1 file changed

+180
-59
lines changed

README.md

Lines changed: 180 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -10,88 +10,210 @@
1010

1111
A powerful, lightweight, single-file application for viewing and editing Markdown documents with LaTeX mathematical notation support.
1212

13-
[Report Bug](https://github.com/g-flame/md-viewer/issues)[Request Feature](https://github.com/g-flame/md-viewer/issues)
14-
![image](https://github.com/user-attachments/assets/b600918a-8a1d-44c1-ae90-9713c612ddf9)
13+
[📝 Report Bug](https://github.com/g-flame/md-viewer/issues)[✨ Request Feature](https://github.com/g-flame/md-viewer/issues)
1514

15+
![Markdown & LaTeX Viewer Screenshot](https://github.com/user-attachments/assets/b600918a-8a1d-44c1-ae90-9713c612ddf9)
1616

1717
</div>
1818

1919
---
2020

21+
## 📋 Table of Contents
22+
23+
- [✨ Features](#-features)
24+
- [🚀 Getting Started](#-getting-started)
25+
- [💻 How to Use](#-how-to-use)
26+
- [📦 Installation](#-installation)
27+
- [🔍 Advanced Features](#-advanced-features)
28+
- [🌐 Browser Compatibility](#-browser-compatibility)
29+
- [⚠️ Known Limitations](#️-known-limitations)
30+
- [🛠️ Roadmap](#️-roadmap)
31+
- [📄 License](#-license)
32+
- [👨‍💻 Author](#-author)
33+
34+
---
35+
2136
<div align="center">
2237

2338
## ✨ Features
2439

2540
</div>
2641

27-
- ** Markdown Parsing**: Support for all standard Markdown elements
28-
- `# Headers`
29-
- `- Bullets`
30-
- `> Blockquotes`
31-
- ` ```code blocks``` `
32-
- `**Bold**` and `*Italic*` text
33-
- `[Links](url)` and more
42+
### 📝 Markdown Support
43+
- **Headers** (`# H1`, `## H2`, etc.) with automatic hierarchy and navigation
44+
- **Text Formatting**: `**Bold**`, `*Italic*`, `~~Strikethrough~~`, `==Highlight==`
45+
- **Lists**: Ordered, unordered, and nested lists with proper indentation
46+
- **Tables**: Full support with alignment options and cell formatting
47+
- **Blockquotes**: Multi-level quote formatting with `>`
48+
- **Code**: Inline code with backticks and fenced code blocks with syntax highlighting
49+
- **Links**: Both inline `[text](url)` and reference-style links
50+
- **Images**: Embed with `![alt](url)` with responsive sizing
51+
- **Horizontal Rules**: Section breaks with `---`
52+
- **Task Lists**: Interactive checkboxes with `- [ ]` and `- [x]`
53+
54+
### 🧮 LaTeX Mathematical Notation
55+
- **Inline Equations**: Use `$...$` for inline math like $E = mc^2$
56+
- **Block Equations**: Centered equations with `$$...$$`:
57+
```
58+
$$ \int_0^{\infty} e^{-x^2} dx = \frac{\sqrt{\pi}}{2} $$
59+
```
60+
- **Matrices, Fractions, and Advanced Notation**: Comprehensive math typesetting
61+
- **Automatic Numbering**: For theorem environments and equation references
62+
63+
### 🔧 Editor Tools
64+
- **Real-time Preview**: See changes as you type with split-screen view
65+
- **Syntax Highlighting**: Color-coded editor for easier editing
66+
- **Toolbar**: Formatting shortcuts for common Markdown elements
67+
- **Search**: Full-text search with highlighting and navigation
68+
- **Word Count**: Real-time statistics for document length
69+
70+
### 💾 File Operations
71+
- **Export Options**: Save as Markdown (.md)
72+
- **Auto-save**: Recover work with local storage backup
73+
- **File Drag & Drop**: Easy document loading
74+
- **Keyboard Shortcuts**: Productivity enhancers for power users
3475

35-
- ** LaTeX Support**:
36-
- Inline equations: `$E = mc^2$` → $E = mc^2$
37-
- Block equations:
38-
```
39-
$$ \int_0^{\infty} e^{-x^2} dx = \frac{\sqrt{\pi}}{2} $$
40-
```
76+
---
4177

42-
- ** Dark/Light Mode**: Not implemented yet!
78+
## 🚀 Getting Started
4379

44-
- ** Search Functionality**: Real-time content filtering
80+
Markdown & LaTeX Viewer requires no installation or setup. It's a single HTML file that works locally in any modern browser without an internet connection.
4581

46-
- ** Export**:
47-
- Markdown (.md)
82+
### System Requirements
83+
- Any device with a modern web browser
84+
- No internet connection required after initial download
85+
- Minimal system resources (works on older devices)
4886

87+
---
4988

50-
- ** Responsive Design**: Works on mobile, tablet, and desktop
51-
- ** Zero Dependencies**: Single HTML file with embedded CSS and JavaScript
89+
## 💻 How to Use
90+
91+
1. **Launch the Application**:
92+
- Double-click the HTML file to open in your default browser
93+
- Alternatively, drag the file into any browser window
94+
95+
2. **Create or Edit Content**:
96+
- Use the left pane to write or edit your Markdown
97+
- See the rendered output in real-time on the right pane
98+
99+
3. **Format Your Document**:
100+
- Use the formatting toolbar for common elements
101+
- Or type Markdown syntax directly for more control
102+
103+
4. **Use Markdown Elements**:
104+
```markdown
105+
# This is a heading
106+
107+
This is a paragraph with **bold** and *italic* text.
108+
109+
- List item 1
110+
- List item 2
111+
- Nested item
112+
113+
1. Ordered item 1
114+
2. Ordered item 2
115+
116+
> This is a blockquote
117+
118+
`inline code` looks like this
119+
120+
```javascript
121+
// Code block with syntax highlighting
122+
function hello() {
123+
console.log("Hello, world!");
124+
}
125+
```
126+
```
127+
128+
5. **Add Mathematical Notation**:
129+
- For inline equations: `$E = mc^2$`
130+
- For block equations:
131+
```
132+
$$ \frac{d}{dx}\left( \int_{a}^{x} f(u)\,du\right)=f(x) $$
133+
```
134+
135+
6. **Save Your Work**:
136+
- Use the Export button to save as a Markdown file
137+
- Content is automatically saved in your browser's local storage
138+
139+
7. **Share Your Document**:
140+
- Export to Markdown and share the file
141+
- Or save as HTML for a self-contained document
52142
143+
---
53144
54-
## How to Use
145+
## 📦 Installation
55146
56-
</div>
147+
No installation required! The application is a single, self-contained HTML file.
57148
58-
1. **Open** the HTML file in any modern browser
59-
2. **Edit** your content in the editor pane
60-
3. **Preview** your content in real-time
61-
4. **Format** using the toolbar or Markdown syntax
62-
5. **Save** locally or to the cloud
63-
6. **Share** via export or link
149+
### Download Options:
150+
- Download directly from the [releases page](https://github.com/g-flame/markdown-latex-viewer/releases)
151+
- Clone the repository: `git clone https://github.com/g-flame/markdown-latex-viewer.git`
64152
65-
<div align="center">
153+
### Quick Setup:
154+
1. Download the HTML file
155+
2. Save it anywhere on your device
156+
3. Open it with any modern web browser
157+
4. Start creating or editing Markdown documents
66158
67-
## Installation
159+
---
68160
69-
</div>
161+
## 🔍 Advanced Features
70162
71-
##### No installation required! Simply download the single HTML file and open it in any browser:
72-
#### download directly from the [releases page](https://github.com/g-flame/markdown-latex-viewer/releases).
163+
### Keyboard Shortcuts
164+
| Action | Windows/Linux | macOS |
165+
|--------|---------------|-------|
166+
| Bold | Ctrl+B | ⌘+B |
167+
| Italic | Ctrl+I | ⌘+I |
168+
| Save | Ctrl+S | ⌘+S |
169+
| Find | Ctrl+F | ⌘+F |
170+
| New Document | Ctrl+N | ⌘+N |
171+
| Toggle Preview | Ctrl+P | ⌘+P |
73172
74-
<div align="center">
173+
### Command Palette
174+
Access all features with `Ctrl+Shift+P` (or `⌘+Shift+P` on macOS) to open the command palette.
75175
76-
## Browser Compatibility
176+
---
77177
78-
</div>
178+
## 🌐 Browser Compatibility
79179
80-
| Browser | Version |
81-
|---------|---------|
82-
| Chrome | 88+ |
83-
| Firefox | 85+ |
84-
| Safari | 14+ |
85-
| Edge | 88+ |
86-
| Opera | 75+ |
180+
Extensively tested and optimized for the following browsers:
87181
88-
<div align="center">
182+
| Browser | Minimum Version | Recommended |
183+
|---------|-----------------|-------------|
184+
| Chrome | 88+ | Latest |
185+
| Firefox | 85+ | Latest |
186+
| Safari | 14+ | Latest |
187+
| Edge | 88+ | Latest |
188+
| Opera | 75+ | Latest |
189+
| Mobile Browsers | Modern versions | Latest |
89190
90-
## License
191+
---
91192
92-
</div>
193+
## ⚠️ Known Limitations
194+
195+
- Dark/Light mode toggle is planned but not yet implemented
196+
- LaTeX rendering may be slower for extremely complex equations
197+
- Limited export formats (PDF export coming soon)
198+
- No cloud storage integration (planned for future releases)
199+
200+
---
201+
202+
## 🛠️ Roadmap
93203
94-
Distributed under the MIT License. See `LICENSE` for more information.
204+
- [ ] Dark/Light mode toggle
205+
- [ ] PDF export functionality
206+
- [ ] Collaborative editing
207+
- [ ] Mobile app versions
208+
- [ ] Custom themes and styling options
209+
- [ ] Plugins system for extensibility
210+
- [ ] Offline PWA support
211+
212+
---
213+
214+
## 📄 License
215+
216+
Distributed under the MIT License. See below for more information:
95217
96218
```
97219
MIT License
@@ -117,20 +239,19 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
117239
SOFTWARE.
118240
```
119241
120-
<div align="center">
242+
---
121243
122-
## Author
244+
<div align="center">
123245
124-
</div>
246+
## 👨‍💻 Author
125247
126-
<div align="center">
127-
<a href="https://github.com/g-flame">
128-
<img src="https://github.com/g-flame.png" width="100px" alt="G-flame" style="border-radius:50%"/>
129-
</a>
130-
<br />
131-
<b>G-flame</b>
132-
<br />
133-
<a href="https://github.com/g-flame">GitHub</a> •
248+
<a href="https://github.com/g-flame">
249+
<img src="https://github.com/g-flame.png" width="100px" alt="G-flame" style="border-radius:50%"/>
250+
</a>
251+
<br />
252+
<b>G-flame</b>
253+
<br />
254+
<a href="https://github.com/g-flame">GitHub</a>
134255
</div>
135256
136257
---

0 commit comments

Comments
 (0)