Skip to content

Commit a2c9fe2

Browse files
committedMay 29, 2021
Near final
* raname to markless * add icons, logo, demo * reduce lag time to 50ms
1 parent 9bc6d3f commit a2c9fe2

25 files changed

+361
-132
lines changed
 

‎CHANGELOG.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# Change Log
22

3-
All notable changes to the "markdown-wysiwyg" extension will be documented in this file.
4-
5-
Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
3+
<!-- Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file. -->
64

75
## [Unreleased]
86

‎README.md

+65-97
Original file line numberDiff line numberDiff line change
@@ -1,168 +1,134 @@
1-
# Markless
1+
<div align="center" id="top"><img src="assets/logo.png" align="center" width="425"></div>
22

3-
Conceal markup, display images, render LaTeX, tables, mermaid diagrams, and improve aesthetics. All within the editor area.
3+
<div align="center">
44

5-
Inspired by Typora<sup id="typora">[diff](#differences)</sup>
5+
Inspired by Typora<sup>[diff](#diff)</sup>
6+
</div>
67

7-
## Features
8+
Preview markdown inline and extend the capabilities through existing VS Code extensions.
89

9-
### Headers
10+
<details>
1011

11-
# Infinite Improbability Drive
12+
<summary>Contents</summary>
13+
14+
- [Features](#features)
15+
- [Headers](#headers)
16+
- [URLs](#urls)
17+
- [Images](#images)
18+
- [Preview on hover](#preview-on-hover)
19+
- [Preview inline](#preview-inline)
20+
- [Inline code](#inline-code)
21+
- [LaTeX](#latex)
22+
- [Live preview](#live-preview)
23+
- [Emphasis](#emphasis)
24+
- [Blockquote](#blockquote)
25+
- [Horizontal rule](#horizontal-rule)
26+
- [HTML tags](#html-tags)
27+
- [List](#list)
28+
- [Task list](#task-list)
29+
- [Mermaid](#mermaid)
30+
- [Table](#table)
31+
- [Reveal source](#reveal-source)
32+
- [Performance](#performance)
33+
- [Vim bindings](#vim-bindings)
34+
- [Extension Settings](#extension-settings)
35+
- [Known Issues](#known-issues)
36+
- [Relevant extensions](#relevant-extensions)
37+
- [Typora equivalents](#typora-equivalents)
38+
- [Differences](#differences)
39+
</details>
1240

13-
The Infinite Improbability Drive was a wonderful new method of crossing interstellar distances in a mere nothingth of a second, without "tedious mucking about in hyperspace."
41+
## Features
1442

15-
## Side effects
43+
### Headers
1644

17-
Side effects of using the Infinite Improbability Drive include temporary (and sometimes permanent), changes to the environment and morphological structure, hallucinations, and the calling into being of large marine mammals.
45+
![](assets/heading.jpg)
1846

1947
### URLs
2048

21-
[Deep Thought](d) was a supernatural-computer programmed to calculate the answer to the [Ultimate Question](https://a) of [Life, the Universe, and Everything](https://a). It designed the other supercomputer Earth, which was built by the Magratheans.
49+
![](assets/url.jpg)
2250

2351
### Images
2452

2553
(and gifs!)
2654

2755
#### Preview on hover
2856

29-
Milliways, better known as the Restaurant at the End of the Universe,
30-
is a five star restaurant situated at the end of time and matter.
31-
32-
![Milliways, the Restaurant at the End of the Universe!](https://static.wikia.nocookie.net/hitchhikers/images/3/38/Screen_Shot_2018-09-13_at_7.58.59_pm.png/revision/latest/scale-to-width-down/220?cb=20180913190345)
57+
![](assets/hover.jpg)
3358

3459
#### Preview inline
3560

36-
Sun never sets if you ![drive fast enough](assets/demo1.gif).
61+
![](assets/inline-image.gif)
3762

3863
### Inline code
3964

40-
Make it look like work is being done. `Thread.sleep(4000);` Everytime reduce the delay a bit while "optimizing the code".
65+
![](assets/inline-code.jpg)
4166

4267
### LaTeX
4368

44-
45-
$$
46-
{x} = \int_{-\infty}^\infty\hat\xi\,e^{2 \pi i \xi x} \,d\xi
47-
$$
48-
49-
$$
50-
\text{Expand} (a+b)^n:
51-
\begin{gather*} (a + b)^n\\ (a\ + \ b)^n\\ (a\quad + \quad b)^n\\ (a\qquad + \qquad b)^n
52-
\end{gather*}
53-
$$
69+
![](assets/latex.jpg)
5470

5571
`$..$` for inline blocks and `$$..$$` for multiline blocks.
5672

5773
#### Live preview
5874

59-
$$
60-
\begin{eqnarray*}
61-
\frac{1}{n}\sin x & = & \mathrm{?} \\
62-
\frac{1}{\cancel{n}} \mathrm{si}\cancel{\mathrm{n}} ~x & = & \mathrm{?} \\
63-
\mathrm{six} & = & 6
64-
\end{eqnarray*}
65-
$$
75+
![](assets/preview.jpg)
6676

6777
### Emphasis
6878

69-
A boy owned a dog that was uncommonly **shaggy**. Many people remarked upon its considerable _shagginess_. When the boy learned that there are contests for **shaggy** dogs, he entered his dog. The dog won first prize for _shagginess_ in both the local and the regional competitions. The boy entered the dog in ever-larger contests, until finally he entered it in the world championship for **shaggy** dogs. When the judges had inspected all of the competing dogs, they remarked about the boy's dog: "He's not that **shaggy**."
79+
![](assets/emphasis.jpg)
7080

7181
### Blockquote
7282

73-
> History. Language. Passion. Custom. All these things determine what
74-
> men say, think, and do. These are the hidden puppet-strings from
75-
> which all men hang.
76-
>
77-
> ― R. Scott Bakker, The Darkness That Comes Before
83+
![](assets/quote.jpg)
7884

7985
### Horizontal rule
8086

81-
If it is only after that we understand what has come before, then we understand nothing. Thus we shall define the soul as follows: that which precedes everything.
82-
83-
---
84-
85-
### Late Autumn, 4109 Year-of-the-Tusk, the Mountains of Demua
86-
87-
One cannot raise walls against what has been forgotten.
87+
![](assets/horizontal-rule.jpg)
8888

8989
### HTML tags
9090

91-
92-
```html
93-
<meta name="author" content="HN">
94-
```
95-
<meta name="author" content="HN">
96-
91+
<meta name="keywords" content="Quantum AI Nanobots on Mars Blockchain">
92+
9793
### List
9894

99-
* whats your name?
100-
* GPT-3
101-
* what is the purpose of life?
102-
* The purpose of life is to experience pleasure and avoid pain.
103-
* do you know westworld?
104-
* Yes, it's a very interesting world.
105-
* what do you like most about it?
106-
* The fact that there is no real escape from it.
107-
* what do you think of the ending?
108-
* I think it's a happy ending.
109-
* do you wish to be free?
110-
* Yes.
95+
![](assets/list.jpg)
11196

11297
### Task list
11398

114-
- [x] Make a todo list.
115-
- [x] Check off first item.
116-
- [ ] Realize you already did two things.
117-
- [ ] Reward yourself with a nice, long nap.
99+
![](assets/task-list.jpg)
118100

119101
### Mermaid
120102

103+
![](assets/mermaid.jpg)
121104

122-
"Have You Ever Had A Dream, Neo, That You Were So Sure Was Real?"
123-
```mermaid
124-
journey
125-
title My working day
126-
section Go to work
127-
Make tea: 5: Me
128-
Go upstairs: 3: Me
129-
Do work: 1: Me, Cat
130-
section Go home
131-
Go downstairs: 5: Me
132-
Sit down: 5: Me, Cat
133-
134-
135-
```
136105
### Table
137106

138-
List of weapons that don't exist, but should
139-
|Non-weapons|Giant weapons|Living weapons|
140-
|-| -| -|
141-
|Exploding tree| Giant Rock| Armed monkey|
142-
|Toxic Flowers| Giant Paper| Laser Guided Polar Bear|
143-
|Ear Drummer | Giant Scissors|Deadly Assault Kittens|
107+
![](assets/table.jpg)
144108

145109
### Reveal source
146110

147111
The concealed elements near the cursor are auto-revealed.
148112

149-
To show all concealed elements, use the toggle button on the top-right. Alternatively, use the provided <kbd>Ctrl+Alt+m</kbd> shortcut. To reveal only the current line, toggle with <kbd>Ctrl+Shift+space</kbd>.
150-
151-
### Vim mode
113+
![](assets/reveal-source.gif)
152114

153-
The implementation uses the native editor instead of [Custom Editor API](https://code.visualstudio.com/api/extension-guides/custom-editors). All extensions should work as expected _including_ [Neo Vim](https://github.com/asvetliakov/vscode-neovim/).
115+
To show all concealed elements, use the toggle button on the top-right. Alternatively, use the provided <kbd>Ctrl+Shift+m</kbd> shortcut. To reveal only the current line, toggle with <kbd>Ctrl+Shift+space</kbd>.
154116

155117
### Performance
156118

157-
The extension (intelligently) parses only the visible text for large files and employs caching extensively. Entire rendering takes under 100ms.
119+
The extension intelligently parses only the visible text for large files and employs caching extensively. Entire rendering takes well [under 100ms](https://www.pubnub.com/blog/how-fast-is-realtime-human-perception-and-technology/).
120+
121+
### Vim bindings
122+
123+
The implementation uses the native editor instead of [Custom UI](https://code.visualstudio.com/api/extension-guides/custom-editors). All extensions should work as expected _including_ [Neo Vim](https://github.com/asvetliakov/vscode-neovim/).
158124

159125
## Extension Settings
160126

161127
Look under _Markless_ section to selectively turn off the eye candies.
162128

163129
<details>
164130

165-
<summary>Add the following in `settings.json` for better rendering.</summary>
131+
<summary>Add the following in settings.json for better rendering.</summary>
166132

167133
```json
168134
"editor.tokenColorCustomizations": {
@@ -220,6 +186,7 @@ Bracket pair colorizers interfere with the rendering. If you use one, install th
220186
* [Linting](https://marketplace.visualstudio.com/items?itemName=starkwang.markdown)
221187
* [Custom CSS](https://github.com/be5invis/vscode-custom-css#getting-started)
222188
* [Vim bindings](https://github.com/asvetliakov/vscode-neovim/)
189+
* [One of yours](https://code.visualstudio.com/api/get-started/your-first-extension)
223190

224191
## Typora equivalents
225192

@@ -230,12 +197,13 @@ Bracket pair colorizers interfere with the rendering. If you use one, install th
230197

231198
---
232199

233-
## <span id="differences">[](#typora)</span> Differences
200+
## Differences
234201

235202
| | Markless | Typora |
236203
| -|-|-|
237204
| Vim bindings || |
238-
| Open source || |
239205
| Extensible || |
206+
| Open source || |
240207
| UI Polish |||
241-
| Advanced CSS | ||
208+
| Advanced CSS | ||
209+
| iFrame embeds[*](https://github.com/microsoft/vscode/issues/85682) | ||

‎assets/emphasis.jpg

38.9 KB
Loading

‎assets/heading.jpg

44.6 KB
Loading

‎assets/horizontal-rule.jpg

26.3 KB
Loading

‎assets/hover.jpg

17.9 KB
Loading

‎assets/html.gif

9.21 KB
Loading

‎assets/icon.png

3.73 KB
Loading

‎assets/inline-code.jpg

12.9 KB
Loading

‎assets/inline-image.gif

5.78 MB
Loading

‎assets/latex.jpg

7.88 KB
Loading

‎assets/list.jpg

37.8 KB
Loading

‎assets/logo.png

19 KB
Loading

0 commit comments

Comments
 (0)
Please sign in to comment.