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
This plugin converts Pandoc's Markdown into HTML 5. Conversion from other flavours of Markdown are supported but requires the use of a default file as described [here](https://github.com/nandac/pandoc-reader#method-two-using-pandoc-defaults-files).
40
40
41
-
o formats other than HTML 5 is not supported.
41
+
Converting to formats other than HTML 5 is not supported.
42
42
43
43
### Specifying File Metadata
44
44
45
-
The plugin expects all markdown files to start with a YAML block as shown below.
45
+
The plugin expects all Markdown files to start with a YAML block as shown below.
46
46
47
47
```yaml
48
48
---
@@ -62,11 +62,11 @@ date: "<date>"
62
62
...
63
63
```
64
64
65
-
**Note: The plugin supports Pandoc's YAML syntax for specifying metadata. However, Pelican's format for metadata is different and may need to be rewritten if you stop using this plugin.
65
+
**Note: The plugin supports Pandoc's YAML syntax for specifying metadata. However, Pelican's format for metadata is different and may need to be rewritten if you stop using this plugin.**
66
66
67
-
YAML blocks that define more that one level such as YAML lists are not supported although they are supported by Pandoc. This is due to metadata processing limitations. In cases where you would normally add a YAML list use a comma separated string such as when specifying tags.
67
+
YAML blocks that define more that one level such as YAML lists are not supported although they are supported by Pandoc. This is due to metadata processing limitations. In cases where you would normally add a YAML list use a comma separated string, such as when specifying tags for your blogs.
68
68
69
-
More information on Pandoc's Metadata blocks are available [here](https://pandoc.org/MANUAL.html#metadata-blocks).
69
+
More information on Pandoc's YAML metadata blocks are available [here](https://pandoc.org/MANUAL.html#metadata-blocks).
70
70
71
71
Information about Pelican's predefined metadata is available [here](https://docs.getpelican.com/en/stable/content.html#file-metadata).
72
72
@@ -101,7 +101,7 @@ PANDOC_EXTENSIONS = [
101
101
102
102
#### Method Two: Using Pandoc Default Files
103
103
104
-
The second method involves specifying the path(s) to one or more default file(s) with all your preferences written in YAML format.
104
+
The second method involves specifying the path(s) to one or more YAML default file(s) with all your preferences.
105
105
106
106
These paths should be set in your `pelicanconf.py` file by using the setting `PANDOC_DEFAULT_FILES`. The paths maybe absolute or relative but we recommend using relative paths as they are more portable.
107
107
@@ -192,21 +192,21 @@ Without these settings citations will not be processed by the plugin.
192
192
193
193
You may write your bibliography in any format supported by Pandoc with the appropriate extensions specified. However, you **must** name the bibliography file the same as your blog.
194
194
195
-
For example, a blog with the file name `my-blog.md` should have a bibliography file called `my-blog.bib`, `my-blog.json`, `my-blog.yaml` or `my-blog.bibtex`in the same directory as your blog or in a subdirectory of the directory that your blog resides in. Failing to do so will mean that the citations will not be picked up.
195
+
For example, a blog with the file name `my-blog.md` should have a bibliography file called `my-blog.bib`, `my-blog.json`, `my-blog.yaml` or `my-blog.bibtex`in the same directory as your blog or in a subdirectory of the directory that your blog resides in. Failing to do so will mean that the references will not be picked up.
196
196
197
197
### Calculating and Displaying Reading Time
198
198
199
-
The plugin can be set to calculate the reading time of articles and pages by setting `CALCULATE_READING_TIME` to `True` in your `pelicanconf.py` file.
199
+
The plugin can be used to calculate the reading time of articles and pages by setting `CALCULATE_READING_TIME` to `True` in your `pelicanconf.py` file.
200
200
201
201
```python
202
202
CALCULATE_READING_TIME = True
203
203
```
204
204
205
-
You may display the reading time using the `{{ article.reading_time }}` or `{{ page.reading_time }}` template variables. The unit of time will be displayed as minute or minutes depending on whether the reading time is less than or equal to one minute or greater than one minute.
205
+
You may display the reading time using the `{{ article.reading_time }}` or `{{ page.reading_time }}` template variables. The unit of time, will be displayed as minute or minutes, depending on whether the reading time is less than or equal to one minute, or greater than one minute.
206
206
207
-
The reading time is calculated by dividing the number of words by the reading speed, which is set to the average number of words read in one minute.
207
+
The reading time is calculated by dividing the number of words by the reading speed.
208
208
209
-
The default value for reading speed is set to 200 words per minute, but may be customized by setting `READING_SPEED` to the desired words per minute integer value in `pelicanconf.py`.
209
+
The default value for reading speed is set to 200 words per minute, but may be customized, by setting `READING_SPEED` to the desired words per minute integer value in `pelicanconf.py`.
210
210
211
211
```python
212
212
READING_SPEED = <words-per-minute>
@@ -216,7 +216,7 @@ The number of words in a document is calculated by a Pandoc Lua Filter called [w
216
216
217
217
### Known Issues
218
218
219
-
The posts and pages of your site can take several seconds to be converted to HTML if linking to a Citation Style Language (CSL) specification, using a URL, as shown below:
219
+
The posts and pages of your site can take several seconds to get converted to HTML if linking to a Citation Style Language (CSL) specification, using a URL, as shown below:
This is due to the need to re-download the CSL specification for every post or page causing long processing times.
233
+
This is due to the need to download the CSL file for each post or page causing long processing times.
234
234
235
-
To overcome this issue, you may download a local copy of the CSL file to your machine or webserver, and give the `csl` argument a relative path to the file. This speeds up processing by 10x.
235
+
To overcome this issue, you may download a local copy of the CSL file to your machine or webserver. The set the `csl` argument to a relative path to the file. This speeds up processing by 10x.
0 commit comments