turmflx commited on
Commit
76a2b3a
·
verified ·
1 Parent(s): 0da5d4a

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +68 -3
README.md CHANGED
@@ -1,3 +1,68 @@
1
- ---
2
- license: mit
3
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # HTML‑Viewer.org
2
+ > A browser‑native HTML/CSS/JS sandbox with two‑way element‑code sync and visual preview editing
3
+
4
+ 🔗 Live site: https://html-viewer.org
5
+
6
+ ## What is this tool for?
7
+ When you write or study web code, it can be hard to tell which lines of code produce which parts of the rendered page. HTML‑Viewer solves this pain point.
8
+
9
+ This is an all‑in‑one web sandbox that runs entirely inside your browser. You don’t need to install software or create accounts. Paste your HTML, CSS and JavaScript, and you get instant live preview.
10
+
11
+ The standout capability is **bidirectional highlighting**:
12
+ - Click code on the left → the corresponding page element lights up in preview
13
+ - Click content in preview → jump straight to the matching source code lines
14
+
15
+ This is extremely helpful for debugging broken layouts, learning how HTML works, and hunting down where a particular style or text comes from.
16
+
17
+ On top of code inspection, you can also edit content directly inside the preview window. Use the toolbar to make text bold, change font sizes, add images, or build lists. The tool automatically writes the correct HTML markup for you, so you avoid typing repetitive tags manually.
18
+
19
+ All parsing, rendering and file handling happens locally on your device. Your code never gets uploaded to any server, keeping your work private.
20
+
21
+ ## Main capabilities
22
+ ### Two‑way sync highlight
23
+ - Trace connections between source code and rendered webpage elements
24
+ - Toggle sync on or off to avoid interference while writing large blocks of code
25
+
26
+ ### Visual WYSIWYG editing on preview
27
+ - Format text: bold, italic, font‑size, alignment
28
+ - Insert images, ordered lists, unordered lists
29
+ - All edits reflect instantly into the source code editor
30
+
31
+ ### Helpful developer utilities
32
+ - Import local HTML / CSS / JS files
33
+ - Format messy code with one click
34
+ - Basic HTML syntax error detection
35
+ - Export final code to your computer
36
+ - Dark mode
37
+ - Collapse/expand nested code blocks
38
+ - Open preview or source in new tab
39
+
40
+ ## Who can benefit
41
+ - People learning HTML/CSS/JS and want to see real‑time cause‑and‑effect
42
+ - Developers testing small code snippets and quick prototypes
43
+ - Designers checking static page outputs
44
+ - QA personnel investigating display bugs
45
+ - Hobbyists building small web demos and tools
46
+
47
+ ## Preview assets
48
+ ![Two‑way highlight demo](screenshot‑two‑way‑highlight.png)
49
+ ![Visual editing toolbar](screenshot‑visual‑edit‑toolbar.png)
50
+
51
+ Optional demo video: `demo‑html‑viewer‑usage.mp4`
52
+ Shows full workflow of bidirectional highlight and preview‑based visual editing.
53
+
54
+ ## Quick start
55
+ 1. Open https://html-viewer.org in your browser
56
+ 2. Paste code, or import local files
57
+ 3. Watch live preview update on the right
58
+ 4. Use bidirectional highlight to explore code‑element mapping
59
+ 5. Use visual edit mode to modify content directly on preview
60
+ 6. Format code and export to local files when done
61
+
62
+ ## Important notes
63
+ - Best suited for snippets, demos and learning. It is not intended to replace full‑featured IDEs for large production projects.
64
+ - Visual editing works well for content and simple formatting. Advanced layout logic still requires manual code editing.
65
+ - All processing is local, no code is transmitted externally.
66
+
67
+ ## License
68
+ MIT