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
+39-2Lines changed: 39 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ Export [Kirby](https://getkirby.com/) content for use with the [Paperback Book M
4
4
5
5
## What does this plugin do?
6
6
7
-
The plugin generates a lightly formatted plain text file from a set of pages specified by the user.
7
+
The plugin generates a lightly formatted plain text file from a set of pages specified by the user. The text file is used to create a “book” package which can be viewed on a Newton OS device.
8
8
9
9
An example of this file can be downloaded using the following link. The file contains all of the terms currently published on the [Newton Glossary](http://newtonglossary.com/) site.
10
10
@@ -14,9 +14,46 @@ An example of this file can be downloaded using the following link. The file con
14
14
15
15
Paperback is a simple cross-platform utility created by [David Fedor](http://thefedors.com/pobox/) that takes plain text files and quickly packages them for viewing on a Newton OS device. Since the Paperback utility only runs under classic Mac OS and Windows, an online [Paperback Book Maker](https://ritsuko.chuma.org/paperback/) was developed by [Victor Rehorst](https://github.com/chuma) for all your cross-platform needs.
16
16
17
+
## Installation
18
+
19
+
After installing the plugin using one of the methods listed below, visiting `yoursite.com/export/paperback` should automatically download a text file without any additional configuration.
20
+
21
+
### Download
22
+
23
+
To install the plugin manually, [download the files](https://github.com/splorp/kirby-paperback-export/archive/master.zip) and put them in:
24
+
25
+
`site/plugins/paperback-export`
26
+
27
+
### Kirby CLI
28
+
29
+
Installing the plugin using the Kirby [command line interface](https://github.com/getkirby/cli):
By default, Kirby Paperback Export will include the text of every page on your Kirby site, including invisible pages. The following options allow you to select and filter which pages are included.
56
+
By default, Kirby Paperback Export will include the text from the title and description fields for every page on your Kirby site, including invisible pages. The following options allow you to select and filter which pages are included.
0 commit comments