Skip to content

Commit 4f2e411

Browse files
Clevis22Clevis22
committed
updated readme
1 parent 48eafff commit 4f2e411

File tree

4 files changed

+63
-54
lines changed

4 files changed

+63
-54
lines changed

‎about.html

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,8 @@
44
<meta charset="UTF-8">
55
<meta name="viewport" content="width=device-width, initial-scale=1.0">
66
<title>About SplitMark</title>
7+
<meta name="description" content="SplitMark is a free, minimalist online text editor with Markdown capabilities, keyboard shortcuts, and a streamlined interface for distraction-free writing.">
78
<link rel="stylesheet" href="style.css">
8-
<!-- FontAwesome for icons -->
9-
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css" integrity="sha512-DTOQO9RWCH3ppGqcWaEA1BIZOC6xxalwEsw9c2QQeAIftl+Vegovlnee1c9QX4TctnWMn13TZye+giMm8e2LwA==" crossorigin="anonymous" referrerpolicy="no-referrer" />
109

1110
<style>
1211
#editor-container{
@@ -41,6 +40,10 @@ <h1 style="text-align:center;">SplitMark</h1>
4140
<p style="text-align:center;">No login, no ads just minimalist text editing with markdown superpowers.</p>
4241
<h2>About</h2>
4342
<p>SplitMark is a minimalist Quill-based text editor with markdown support. It is designed to be minimal yet powerful, with a clean and simple user interface paired with the capability of markdown and keyboard shortcuts. SplitMark gives you all the power of WYSIWYG rich text editors in an online minimalist package.</p>
43+
<h2>How It Works</h2>
44+
<p>At its core, SplitMark is a Quill-based text editor. Quill is a free, open-source JavaScript library that allows developers to create rich text editors for the web. Quill also supports third-party modules such as Quilljs-Markdown, which SplitMark uses, along with custom methods to add markdown support to Quill.</p>
45+
<p>All editing on SplitMark happens on the client side, meaning your text never leaves your browser unless you save the content to your device. Saves are stored using the .spmk file extension, which is JSON-based and stores the editor's content. Local storage is also used to store editor content in your browser between sessions.</p>
46+
<p>All of this combined with a minimal ui with light/dark themes, powerful keybord shortcuts and a privacy focussed mentality creates a distraction free yet powerful online writing experience.</p>
4447
<h2>Dependencies</h2>
4548
<p>SplitMark is powered by <a href="https://quilljs.com/">Quill</a> and <a href="https://cloverhearts.github.io/quilljs-markdown/">Quilljs-markdown</a>.</p>
4649
<h2>Keyboard Shortcuts</h2>

‎index.html

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@
1111
<link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png">
1212
<link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png">
1313
<link rel="manifest" href="/site.webmanifest">
14-
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css" integrity="sha512-DTOQO9RWCH3ppGqcWaEA1BIZOC6xxalwEsw9c2QQeAIftl+Vegovlnee1c9QX4TctnWMn13TZye+giMm8e2LwA==" crossorigin="anonymous" referrerpolicy="no-referrer" />
1514
</head>
1615
<body>
1716
<div class="menu">

‎readme.md

Lines changed: 57 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,63 @@
1-
# SplitMark
1+
SplitMark
2+
=========
23

3-
SplitMark- minimalist Quill based text editor with markdown support.
4-
<br>
5-
SplitMark is designed to be minimal yet powerful text editor, with a clean and simple user interface paired with the power of markdown and keyboard shortcuts. SplitMark also supports saving and loading files using the .spmk file extension, which is JSON-based and stores the contents of the editor. If you wish to use the real time markdown editor version of SplitMark it can be found at realtime.splitmark.com
4+
No login, no ads just minimalist text editing with markdown superpowers.
65

7-
## Dependencies
8-
SplitMark is powerd by [Quill](https://quilljs.com/) and [Quilljs-markdown](https://cloverhearts.github.io/quilljs-markdown/)
6+
About
7+
-----
98

10-
## Keyboard Shortcuts
11-
* Control Shift C: View word count
12-
* Control +/-: Edit font size
13-
* Control J: Toggle center/left align
14-
* Control U: Underline
15-
* Control Z: Undo
16-
* Control Y: Redo
9+
SplitMark is a minimalist Quill-based text editor with markdown support. It is designed to be minimal yet powerful, with a clean and simple user interface paired with the capability of markdown and keyboard shortcuts. SplitMark gives you all the power of WYSIWYG rich text editors in an online minimalist package.
1710

18-
## Supported Markdown Syntax
11+
How It Works
12+
------------
13+
14+
At its core, SplitMark is a Quill-based text editor. Quill is a free, open-source JavaScript library that allows developers to create rich text editors for the web. Quill also supports third-party modules such as Quilljs-Markdown, which SplitMark uses, along with custom methods to add markdown support to Quill.
15+
16+
All editing on SplitMark happens on the client side, meaning your text never leaves your browser unless you save the content to your device. Saves are stored using the .spmk file extension, which is JSON-based and stores the editor's content. Local storage is also used to store editor content in your browser between sessions.
17+
18+
All of this combined with a minimal ui with light/dark themes, powerful keybord shortcuts and a privacy focussed mentality creates a distraction free yet powerful online writing experience.
19+
20+
Dependencies
21+
------------
22+
23+
SplitMark is powered by [Quill](https://quilljs.com/) and [Quilljs-markdown](https://cloverhearts.github.io/quilljs-markdown/).
24+
25+
Keyboard Shortcuts
26+
------------------
27+
28+
* Control Shift C: View word count
29+
* Control +/-: Edit font size
30+
* Control J: Toggle center/left align
31+
* Control U: Underline
32+
* Control B: Bold
33+
* Control I: Italic
34+
* Control Z: Undo
35+
* Control Y: Redo
36+
37+
Supported Markdown Syntax
38+
-------------------------
39+
40+
SplitMark supports the following markdown syntax:
41+
```
42+
* Headings: # (H1-H7)
43+
* Bullet lists: * and -
44+
* Numbered lists:
45+
1. 1 DEPTH
46+
2. 2 DEPTH
47+
1. 2 SUB-DEPTH
48+
2. 2 SUB-DEPTH
49+
* Bold: **bold** and __bold__
50+
* Highlight: `highlight`
51+
* Strikethrough: ~~strikethrough~~
52+
* Italic: *italic* and _italic_
53+
* Underline: ==underline==
54+
* Code block: ```code block```
55+
* Task lists: [\] and [x]
56+
* Block quote: >
57+
* Link: [text](source)
58+
* Image: ![alt text](source)
1959
```
60+
License
61+
-------
2062

21-
1. 1 DEPTH
22-
2. 2 DEPTH
23-
1. 2 SUB-DEPTH
24-
2. 2 SUB-DEPTH
25-
26-
* Bullet list
27-
- Bullet list
28-
**bold**
29-
__bold__
30-
`hightlight`
31-
~~strikethrough~~
32-
*italic*
33-
_italic_
34-
==underline==
35-
36-
# H1
37-
## H2
38-
### H3
39-
#### H4
40-
##### H5
41-
###### H6
42-
43-
An item with 3 backticks on each side makes a code block.
44-
45-
Task List
46-
[x] Checked item
47-
[ ] Unchecked item
48-
49-
> Block quote
50-
[link text](link URL)
51-
![image alt](image URL)
52-
53-
```
63+
SplitMark is an open source project licensed under the GPL-3.0 license. You can find the full source code on [GitHub](https://github.com/Clevis22/SplitMark-Text).

‎script.js

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11
Quill.register('modules/QuillMarkdown', QuillMarkdown);
2-
var icons = Quill.import('ui/icons');
3-
icons['bold'] = '<i class="fa fa-bold" aria-hidden="true"></i>';
4-
icons['save'] = '<i class="fa fa-save" aria-hidden="true"></i>'; // Add this line
5-
icons['export'] = '<i class="fa fa-file-export" aria-hidden="true"></i>'; // Add this line
2+
63
const customModules = {
74
QuillMarkdown: {
85
ignoreTags: [],

0 commit comments

Comments
 (0)