@warren-bank/expo-docs-ebook
v2.0.1
Published
Scripts to download and convert the official 'Expo SDK Documentation' into ebook formats.
Downloads
5
Readme
Ebook conversion scripts: Expo SDK Documentation
Scripts to download and convert the official Expo SDK Documentation into ebook formats.
Official Documentation
Installation (npm):
mkdir 'workspace'
cd 'workspace'
npm init -y
npm install --save "@warren-bank/expo-docs-ebook"
mv 'node_modules/@warren-bank/expo-docs-ebook' .
rm -rf 'node_modules'
rm -f package*
cd 'expo-docs-ebook'
npm install
Installation (github):
mkdir 'workspace'
cd 'workspace'
wget --content-disposition --no-check-certificate 'https://github.com/warren-bank/expo-docs-ebook/archive/master.zip'
unzip 'expo-docs-ebook-master.zip'
rm -f 'expo-docs-ebook-master.zip'
cd 'expo-docs-ebook-master'
npm install
Installation notes:
- calibre is installed automatically on Windows as a portable executable in:
dep/
- other platforms must ensure that the
ebook-convert
binary can be found in:$PATH
- other platforms must ensure that the
- GitBook is not installed when the default global installation directory exists:
$HOME/.gitbook
Usage:
# to generate all ebook formats: pdf, epub, mobi
npm run "gitbook:all"
# to generate one specific ebook format: pdf
npm run "gitbook:pdf"
# to generate one specific ebook format: epub
npm run "gitbook:epub"
# to generate one specific ebook format: mobi
npm run "gitbook:mobi"
# to cleanup all intermediate work product
# (is run automatically before each build)
npm run "gitbook:clean"
- all ebooks are saved to:
dist/
Configuration:
- file:
.scripts/env.sh
export ebook_version='v32.0.0' export ebook_commit='master'
- specifies that markdown files should be obtained from:https://github.com/expo/expo/tree/master/docs/pages/versions/v32.0.0
- file:
.scripts/assets/cover.jpg
- contains the SDK version number
- by opening the following file in GIMP:
.scripts/.etc/cover-image/2-cover.xcf
- this text can be edited
- an updated JPG can be exported
Legal:
- copyright: Warren Bank
- license: GPL-2.0