@jojovms/scripto 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +59 -0
- package/dist/.nojekyll +0 -0
- package/dist/scripto.js +2973 -0
- package/dist/scripto.umd.cjs +77 -0
- package/dist/style.css +1 -0
- package/package.json +56 -0
package/README.md
ADDED
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# ScriptΕ - Elegant Markdown Viewer
|
|
2
|
+
|
|
3
|
+
[**π Live Demo**](https://shijoshaji.github.io/Scripto/)
|
|
4
|
+
|
|
5
|
+
**ScriptΕ** is a beautiful, lightweight, and offline-capable Markdown viewer designed for simplicity and elegance. It runs entirely in your browser with no backend required.
|
|
6
|
+
|
|
7
|
+
> "Simple, elegant visualization β where every mark becomes meaning."
|
|
8
|
+
|
|
9
|
+
## β¨ Features
|
|
10
|
+
|
|
11
|
+
### π **Instant Preview**
|
|
12
|
+
- **Drag & Drop**: Simply drop any `.md` or `.markdown` file to view it instantly.
|
|
13
|
+
- **File Picker**: Browse files from your local system.
|
|
14
|
+
|
|
15
|
+
### π **Remote Fetching**
|
|
16
|
+
- **URL Support**: Load Markdown files directly from the web.
|
|
17
|
+
- **Smart GitHub Support**: Automatically converts standard GitHub file URLs (blob) to raw format for seamless viewing.
|
|
18
|
+
- **Query Params**: Share links easily using `?url=YOUR_LINK` (e.g., `index.html?url=https://raw.github...`).
|
|
19
|
+
|
|
20
|
+
### π¨ **Visual Experience**
|
|
21
|
+
- **Glassmorphism Design**: Modern, translucent UI with vibrant background animations.
|
|
22
|
+
- **Theme Toggle**: Switch between the default **Cosmic Dark** mode and a clean **Pastel Light** mode.
|
|
23
|
+
- **Responsive**: Perfectly optimized for desktops, tablets, and mobile devices.
|
|
24
|
+
|
|
25
|
+
### π **Accessibility**
|
|
26
|
+
- **Read Aloud**: Integrated Text-to-Speech engine reads your document out loud.
|
|
27
|
+
- **Visual Feedback**: Pulse animation indicates when audio is playing.
|
|
28
|
+
|
|
29
|
+
### π€ **Export & Share**
|
|
30
|
+
- **Rich Text Copy**: Copy your Markdown as formatted Rich Text (HTML) to paste directly into Word, Docs, or emails with styles preserved.
|
|
31
|
+
- **Save as PDF**: Export your document as a clean, styled PDF. (Optimized for both Light and Dark modes).
|
|
32
|
+
|
|
33
|
+
## π How to Use
|
|
34
|
+
|
|
35
|
+
### Local Usage
|
|
36
|
+
1. Download the repository.
|
|
37
|
+
2. Double-click `index.html` to open it in your browser.
|
|
38
|
+
3. **Note**: Some browsers might restrict URL fetching (CORS) when running from `file://`. For full features, run a simple local server:
|
|
39
|
+
```bash
|
|
40
|
+
# Python 3
|
|
41
|
+
python -m http.server 8000
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### Hosting (GitHub Pages)
|
|
45
|
+
This app is "Static-Ready". You can deploy it directly to GitHub Pages, Vercel, or Netlify with zero configuration.
|
|
46
|
+
|
|
47
|
+
## π οΈ Tech Stack
|
|
48
|
+
- **Core**: HTML5, Vanilla CSS3, Vanilla JavaScript (ES6+).
|
|
49
|
+
- **Libraries** (via CDN):
|
|
50
|
+
- [Marked.js](https://marked.js.org/) (Markdown Parser)
|
|
51
|
+
- [DOMPurify](https://github.com/cure53/DOMPurify) (Security/Sanitization)
|
|
52
|
+
- [Ionicons](https://ionic.io/ionicons) (Icons)
|
|
53
|
+
- **Fonts**: [Outfit](https://fonts.google.com/specimen/Outfit) (Google Fonts).
|
|
54
|
+
|
|
55
|
+
## π¨βπ» Credits
|
|
56
|
+
Created by [Shijo Shaji](https://bio.link/shijoshaji).
|
|
57
|
+
|
|
58
|
+
---
|
|
59
|
+
*MIT License*
|
package/dist/.nojekyll
ADDED
|
File without changes
|