Skip to content

Commit 9763e33

Browse files
committed
update README and screenshots
1 parent ad8170e commit 9763e33

4 files changed

Lines changed: 15 additions & 48 deletions

File tree

README.md

Lines changed: 10 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# [beta] Markdown Syntax Highlighting for Notepad++
22

3-
> :warning: **Warning, Warning!**
3+
> :warning: **Warning**
44
>
55
> This branch `feature/emphasis-multiple-words` is still in beta.
66
> If you want trouble-free that do not mess up your existing markdown color schemes, please stick to [master branch][this_repo] as stable version.
@@ -13,28 +13,26 @@ I still need time to confirm if **this version will mess up other things?** Plea
1313

1414
In short:
1515

16-
| | Stable | This Beta |
16+
| | Stable (master branch) | Beta (this branch) |
1717
|---|---|---|
1818
| \*multiple em words\* | only parse the first word | parse ALL words |
1919
| \* bullet points | fully support | not support (use \- or \+ instead) |
2020

2121
## Test and Vote
2222

23-
Stable (master branch):
23+
| Stable (master branch) | Beta (this branch) |
24+
| --- | --- |
25+
| ![stable](/test_stable_master.png) | ![beta](/test_beta_feature.png) |
2426

25-
![stable](/test_stable_master.png)
26-
27-
Beta (This branch):
28-
29-
![beta](/test_beta_feature.png)
30-
31-
file: [test_beta.md](test_beta.md)
27+
- Each "theme" directory contains a XML file. The **filename and scheme name are same as that in master branch**.
28+
- Make sure to re-open Notepad++ to take effect.
29+
- In this branch, here is a file for testing: [test_beta.md](test_beta.md)
3230

3331
Which one do you prefer?
3432

35-
> If you like, welcome to vote in [this post @ Google+ NPP community](https://plus.google.com/+Edditoria/posts/J3gmNNMnJWB?sfc=true).
33+
> If you like, welcome to vote in [this post @ Google+ NPP community](https://plus.google.com/+Edditoria/posts/dhgfRS3B7j4?sfc=true).
3634
37-
## Fix and PR
35+
## Fix and Pull Request
3836

3937
If you can fix all the problem, or if you have an idea, please rise an issue for discussion.
4038

@@ -44,37 +42,6 @@ Thanks!
4442

4543
-----------
4644

47-
## Screenshot
48-
49-
![Markdown in Default Theme of Notepad++][screen_default]
50-
![Markdown in Zenburn Theme of Notepad++][screen_zenburn]
51-
![Markdown in Blackboard Theme of Notepad++][screen_blackboard]
52-
![Markdown in Deep Black Theme of Notepad++][screen_deep_black]
53-
54-
Supports file extensions: `.markdown` and `.md`
55-
Tested: Notepad++ v7.2.2 (Windows 10)
56-
57-
## Usage
58-
59-
1. Download the Markdown language definition file
60-
- **Default Theme** : [userDefineLang_markdown.xml][default_xml]
61-
- **Zenburn Theme** : [userDefineLang_markdown_zenburn.xml][zenburn_xml]
62-
- **Blackboard Theme** : [userDefineLang_markdown_blackboard.xml][blackboard_xml] :new:
63-
- **Deep Black Theme** : [userDefineLang_markdown_deep_black.xml][deep_black_xml] :new:
64-
2. In Notepad++ menu, click `Language` and select `Define your language...` .
65-
3. In User Defined Language windows, click `Import` then open the xml file.
66-
4. Restart Notepad++.
67-
5. Open and test with a Markdown file e.g. [test.md][test_file]
68-
69-
**Enjoy!!**
70-
71-
## Limitations
72-
73-
Need your input to solve the following problems:
74-
75-
- `*em text*` only parse the first word because it will screw up unorder list
76-
- `_em text_`, `__strong text__` and `___em strong text___` only parse the first word because it will screw up some URL contains `example__url`
77-
7845
## Build Script for Developers
7946

8047
In v1.1, a build script is provided for your convenience. It will follow the naming convention. It requires `bash` and `mustache.js` to run.

test_beta.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Markdown Test (Extra)
22

3-
1-2-3 *multiple italic*, **multi bold** and ***multi bold italic***
3+
\1-2-3 *multiple italic*, **multi bold** and ***multi bold italic***
44

5-
I have *a pen. __I have an apple.__ uuh!* Apple pen.
6-
I have **a pen. _I have a pineapple._ uuh!** Pineapple pen!
5+
I have *a pen **I have an apple** uuh* Apple pen.
6+
I have **a pen *I have a pineapple* uuh** Pineapple pen!
77

8-
*Apple pen. **Pine apple** pen. uuh!*
9-
**Pen *Pineapple Apple* Pen!**
8+
I have *a pen __I have an apple__ uuh* Apple pen.
9+
I have **a pen _I have a pineapple_ uuh** Pineapple pen!
1010

1111
\* apple \* pen \* <!-- escape test \* t \* t \* t -->
1212

test_beta_feature.png

-2.34 KB
Loading

test_stable_master.png

-3.68 KB
Loading

0 commit comments

Comments
 (0)