Skip to content

Commit 648e7e9

Browse files
mendelJJ
authored andcommitted
remove Pod::To::BigPage dep and doc how to generate bigpage/epub
1 parent 79bc096 commit 648e7e9

File tree

2 files changed

+29
-1
lines changed

2 files changed

+29
-1
lines changed

META6.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@
99
"auth": "perl6",
1010
"depends": [
1111
"File::Temp",
12-
"Pod::To::BigPage:ver<0.5.2+>",
1312
"Pod::To::HTML:ver<0.6.1+>",
1413
"Test::META",
1514
"Perl6::TypeGraph"

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,35 @@ based on Mojolicious using
9595

9696
This will serve the documentation in port 3000.
9797

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+
98127
## nginx configuration
99128

100129
Latest version of the generated documentation consists only of static

0 commit comments

Comments
 (0)