You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+26-9
Original file line number
Diff line number
Diff line change
@@ -11,6 +11,7 @@
11
11
- Multiple markdown parsers
12
12
- Full control over the compiler options ([markdown-it], [marked], [remark])
13
13
- 30+ Themes ([cleanrmd], [GitHub][github-theme])
14
+
- Custom theme support
14
15
- GitHub Flavored Markdown (GFM)
15
16
- Auto reload on file change
16
17
- Syntax highlighted code blocks ([prism][prism])
@@ -70,6 +71,17 @@ All themes support the following width options:
70
71
71
72
The `auto` option on the `github` and `github-dark` themes has a fixed width with a surrounding border identical to a rendered `README.md` file for a repository hosted on github.com
72
73
74
+
## Custom Theme
75
+
76
+
1. Go to the Advanced Options and click on Settings
77
+
2. Select `CUSTOM` for Content Theme
78
+
3. Upload your Custom Theme below
79
+
4. Specify the Color Scheme of your theme
80
+
81
+
> Your custom theme will be minified automatically on upload and it can be up to 8KB in size.
82
+
83
+
> You can add `<link rel="stylesheet" type="text/css" href="file:///home/me/custom-theme.css">` to your markdown document to speed up development while working on your theme.
84
+
73
85
---
74
86
75
87
# Compiler Options
@@ -149,6 +161,10 @@ Alternatively diagrams can be wrapped in HTML tags:
149
161
</code></pre>
150
162
```
151
163
164
+
- resize the diagram container vertically by dragging the bottom right corner of the code block up or down
165
+
- zoom in and out by holding down the Shift key and then using your mouse wheel
166
+
- pan by holding down the left mouse button and drag in any direction
167
+
152
168
## Syntax
153
169
154
170
Syntax highlighting for fenced code blocks:
@@ -199,7 +215,8 @@ Access to individual sites can be enabled by copy/pasting a URL address into the
199
215
200
216
> Access to all subdomains for a given hostname can be enabled by using a wildcard `https://*.githubusercontent.com`
201
217
202
-
> Access to all ports on `localhost` can be enabled by specifying `http://localhost`, and access only to a specific port by specifying `http://localhost:3000`
218
+
> Access to all ports on `localhost` can be enabled by adding `http://localhost`.
219
+
> Access to a specific port can be enabled by adding `http://localhost:3000`
203
220
204
221
## Allow on All Sites
205
222
@@ -217,7 +234,7 @@ Each enabled origin has an option for content type header detection and path mat
217
234
218
235
### Header Detection
219
236
220
-
When this option is enabled the extension will check for the existence of the `content-type` header with a value set to either the `text/markdown`, `text/x-markdown` or `text/plain`content type.
237
+
When this option is enabled the extension will check if the `content-type` header with a value of `text/markdown`, `text/x-markdown` or `text/plain`is present.
221
238
222
239
### Path Matching
223
240
@@ -230,13 +247,13 @@ It is a simple regular expression that matches URLs ending with:
Unlike Chromium based browsersFirefox will prompt you to download or open files with an external app, that are served with the `text/markdown` content type. For that reason markdown files have to be served using the `text/plain` content type instead.
23
+
Unlike Chromium based browsers, files served with `text/markdown` content type on Firefox will prompt you to download or open the file with an external app. For that reason markdown files have to be served with the `text/plain` content type instead.
24
24
25
-
The following are a few methods to enable `file:///` access on Linux:
25
+
The following are some methods to enable local`file:///` access on Linux:
The `autoreload` feature is available only for content served on `localhost` and it won't work on `file:///` URLs because of CSP (Content Security Policy) limitations.
81
+
The `autoreload` feature is available only for content served on `localhost` and it won't work on `file:///` URLs due to CSP (Content Security Policy) limitations.
82
82
83
-
Any file server can be used locally as long as it serves the markdown files with the `text/plain` content type.
83
+
Any file server can be used locally as long as it serves the markdown files with `text/plain` content type.
84
84
85
85
Here is an example file server using Node.js (replace `me` with your user):
86
86
@@ -107,7 +107,7 @@ express()
107
107
.listen(8000)
108
108
```
109
109
110
-
Go to the Advanced Options page for the extension and enable the `http://localhost` origin (note that port is omitted).
110
+
Go to the Advanced Options page for the extension and add the `http://localhost` origin (note that port is omitted).
111
111
112
112
Run the above JavaScript file using Node.js and navigate to `http://localhost:8000` in Firefox.
113
113
@@ -117,7 +117,7 @@ You can use any other host name configured in your `hosts` file that resolves to
117
117
127.0.0.1 ssd
118
118
```
119
119
120
-
Then you only need to enable that origin `http://ssd` in the Advanced Options page as well.
120
+
Then you only need to add that origin `http://ssd` in the Advanced Options page as well.
121
121
122
122
The above script can be run on system startup using SystemD or any other service manager.
123
123
@@ -127,7 +127,7 @@ The above script can be run on system startup using SystemD or any other service
127
127
128
128
Remote origins that serve markdown files with `text/plain` content type and do not enforce strict CSP (Content Security Policy) can be enabled using the Advanced Options page.
129
129
130
-
For example, content hosted on `gitlab.com` and `bitbucket.org` can be enabled and subsequently it will get rendered:
130
+
For example, content hosted on `gitlab.com` and `bitbucket.org` can be enabled and subsequently it will be rendered:
0 commit comments