From bb53b0877d6716548b227347ed32ab9604c4c90b Mon Sep 17 00:00:00 2001 From: Swaroop C H Date: Sat, 7 Nov 2020 12:40:43 -0800 Subject: [PATCH] Update text from Gitbook to Honkit (#89) --- INSTALL.md | 18 +++++++++++++++--- Makefile | 6 +++--- about.md | 2 ++ revision_history.md | 4 ++++ translation_howto.md | 4 ++-- 5 files changed, 26 insertions(+), 8 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 92c266d8..540fba4e 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,6 +1,18 @@ ``` -npm install -g gitbook-cli -gitbook serve +# install honkit +npm install honkit --save-dev + +# show website running locally +npx honkit serve + +# generate website files +npx honkit build . public --log=debug + +# generate pdf +npx honkit pdf . byte-of-python.pdf + +# generate epub +npx honkit epub . byte-of-python.epub ``` -See http://toolchain.gitbook.com/ebook.html +See https://github.com/honkit/honkit and https://honkit.netlify.app/ diff --git a/Makefile b/Makefile index cc6bc1f8..7e3fc8b6 100644 --- a/Makefile +++ b/Makefile @@ -1,6 +1,6 @@ -# https://toolchain.gitbook.com/setup.html +# https://github.com/honkit/honkit setup: - npm install gitbook-cli -g + npm install honkit --save-dev serve: - gitbook serve + npx honkit serve diff --git a/about.md b/about.md index 19ecf32c..b3d5024c 100644 --- a/about.md +++ b/about.md @@ -30,6 +30,8 @@ For the ninth draft, I switched to [AsciiDoc format](http://asciidoctor.org/docs For the tenth draft, I switched to writing in Markdown + [GitBook](https://www.gitbook.com) format, using the [Spacemacs editor](http://spacemacs.org). +Nov 2020: Since Gitbook abandoned their open source software, migrated to [Honkit, a community-maintained fork of Gitbook legacy](https://github.com/honkit/honkit). + ## About the Author See {{ book.authorUrl }} diff --git a/revision_history.md b/revision_history.md index bb0e840d..f65270f8 100644 --- a/revision_history.md +++ b/revision_history.md @@ -16,6 +16,10 @@ The book needs the help of its readers such as yourselves to point out any parts # Appendix: Revision History {#revision-history} +- No version change + - 06 Nov 2020 + - Migrated from abandoned GitBook to [community-maintained Honkit, a fork of GitBook legacy](https://github.com/honkit/honkit) + - 4.0 - 19 Jan 2016 - Switched back to Python 3 diff --git a/translation_howto.md b/translation_howto.md index 0cda1569..b67207c1 100644 --- a/translation_howto.md +++ b/translation_howto.md @@ -3,6 +3,6 @@ 1. The full source of the book is available from {{ book.sourceUrl }}. 2. Please [fork the repository](https://help.github.com/articles/fork-a-repo). 3. Then, fetch the repository to your computer. You need to know how to use [Git](http://www.git-scm.com) to do that. -4. Read the [GitBook documentation](https://docs.gitbook.com), esp. the [Markdown section](https://docs.gitbook.com/editing-content/markdown). +4. Read the [Honkit documentation](https://honkit.netlify.app), esp. the [Markdown section](https://honkit.netlify.app/syntax/markdown.html). 5. Start editing the `.md` files to translate to your local language. -6. [Sign up on GitBook.com](https://www.gitbook.com), create a book and you can see a beautifully rendered website, with links to download PDF, EPUB, etc. +6. See [INSTALL.md](./INSTALL.md) on how to generate the website, PDF, EPUB.