File tree Expand file tree Collapse file tree 2 files changed +29
-1
lines changed Expand file tree Collapse file tree 2 files changed +29
-1
lines changed Original file line number Diff line number Diff line change 9
9
"auth" : " perl6" ,
10
10
"depends" : [
11
11
" File::Temp" ,
12
- " Pod::To::BigPage:ver<0.5.2+>" ,
13
12
" Pod::To::HTML:ver<0.6.1+>" ,
14
13
" Test::META" ,
15
14
" Perl6::TypeGraph"
Original file line number Diff line number Diff line change @@ -95,6 +95,35 @@ based on Mojolicious using
95
95
96
96
This will serve the documentation in port 3000.
97
97
98
+ ## Building the EPUB and/or the "single big page HTML" documentation
99
+
100
+ The documentation can also be generated in the EPUB format as well as the
101
+ "single big page HTML" format. Please note that some features (eg. inherited
102
+ methods and type graph in the Types section, or syntax highlighting of the code
103
+ examples) are not (yet) available in these formats.
104
+
105
+ These are the prerequisites you need to install:
106
+
107
+ * Pod::To::BigPage 0.5.2 or later
108
+ * Pandoc (EPUB only)
109
+
110
+ You can follow these instructions to install them on Ubuntu or Debian:
111
+
112
+ zef install "Pod::To::BigPage:ver<0.5.2+>"
113
+ sudo apt install pandoc # only if you want to generate EPUB
114
+
115
+ Now that you have the dependencies installed, clone this repository and
116
+ generate the EPUB or "single big page HTML" documentation:
117
+
118
+ git clone https://github.com/Raku/doc.git # clone this repo
119
+ cd doc # enter the cloned repo
120
+ make epub # for the EPUB format,
121
+ # for the "single big page HTML" format use `make bigpage` instead
122
+
123
+ The generated EPUB output you will find in the ` raku.epub ` file in the root of
124
+ the repository and the generated "single big page HTML" output in
125
+ ` html/raku.html ` .
126
+
98
127
## nginx configuration
99
128
100
129
Latest version of the generated documentation consists only of static
You can’t perform that action at this time.
0 commit comments