Gitbook’s practical tips column

Column catalog

• Gitbook introduction
• Gitbook installation
• Gitbook is easy to use
• Gitbook plug-in introduction
• Gitbook error handling

Column details

Gitbook

Gitbook introduction

GitBook is a command line tool based on Node.js. You can use Github/Git and Markdown to produce beautiful electronic documents. GitBook default output format, generated static site * PDF: need to install gitbook-pdf * eBook: need to install ebook-convert * single HTML page: JSON: Generally used for eBook debugging or metadata extraction. To make an eBook using GitBook, you must have two files: Readme.md [main page] summary.md [sidebar page]Copy the code

Gitbook installation

-v # Install Gitbook multiversion hosting tool to host multiple versions of Gitbook at the same time. Gitbook -v install Gitbook -v install Gitbook -v install Gitbook -cli -g It is recommended to use 3.0.0 gitbook fetch 3.0.0 # to enter your project folder, Gitbook init # Generate two basic files: readme. md and summary. md # Start Gitbook Serve # Specify the Gitbook version to start Gitbook Serve --gitbook=3.0.0 # Gitbook --help # uninstall gitbook Specify that the Gitbook version generates static files, Gitbook build will be downloaded first if not locally --gitbook=3.0.0 # List all gitbook versions locally gitbook ls # List all gitbook versions remotely available gitbook ls-remote # Gitbook build --log=debug # Output error message gitbook builid Gitbook PDF. [PDF_Name]Copy the code

Gitbook is easy to use

Write the main interface of the Gitbook project in readme. md, and summary. md is an example of the property readme. md in the sidebar of the Gitbook interface

# Introduction to the main interface------ A brief description of this document### Directory introduction
* [Directory 1] (1.md)
* [Directory 2] (2.md)
* [Directory 3] (2.md)
* [Directory of 4] (4.md)
Copy the code

The SUMMARY. The md example

* [Directory 1] (1.md)
* [Directory 2] (2.md)
* [Directory 3] (2.md)
* [Directory of 4] (4.md)
Copy the code

Json can be created in the project root directory to implement the global configuration file information

{
    "title": "MedusaSorcerer's blog document."."author": "MedusaSorcerer"."description": "MedusaSorcerer's blog document."."language": "zh-hans"."gitbook": "3.0.0"."structure": {
        "readme": "README.md"
    },
    "plugins": [
        "-highlight"."-github"."-search"."-lunr"."livereload"."back-to-top-button"."code"."prism"."copy-code-button"."search-pro"."splitter"."-sharing-plus"."tbfed-pagefooter"."click-reveal"]."pluginsConfig": {
        "tbfed-pagefooter": {
            "modify_label": "Revision date of this document:"."modify_format": "YYYY-MM-DD HH:mm:ss"}},"links": {
        "sidebar": {
            "Blog homepage": "https://juejin.cn/user/2805609406139950"
        },
        "sharing": {
            "google": false."facebook": false."twitter": false."weibo": false."all": false}}}Copy the code

List of supported languages, differences between versions, for reference only

Gitbook plug-in introduction

Highlight Search sharing font- Settings Livereload is enabled by default when a plugin is installed using the “plug-in name” to register in the plugins

Gitbook error handling

1. performnpm install gitbook-cli -gDownload failed

   Go to your Users\ Current User \AppData\Roaming\ NPM \node_modules directory and check whether there is a gitbook-cli directory if there is one, delete the gitbook-cli directory If the directory does not exist, Uninstall the Gitbook legacy files using NPM and retry the downloadCopy the code

2. After the modified project file is saved,gitbook serveHot loading is not supported
   
   When you modify the Gitbook project and save it, the serve restart prompts that the mkdir operation cannot be used, so that the purpose of restart cannot be achieved
   
   Then you need to do the following:
   • Find what you downloadedgitbookVersion folder: normally locatedUsers\ Current user \.gitbook\versions\The folder name corresponding to the version number will be displayed below
   • Find it in the corresponding version folderlib\cli\serve.jsfile
   • Copy the following code to placeserve.jsIn the file

     /* First line of code */
     const fs=require("fs");
     
     /* Any blank space */
     function deleteFolder(path) {
     let files = [];
     if( fs.existsSync(path) ) {
         files = fs.readdirSync(path);
         files.forEach(function(file,index){
             let curPath = path + "/" + file;
             if(fs.statSync(curPath).isDirectory()) {
                 deleteFolder(curPath);
             } else{ fs.unlinkSync(curPath); }}); fs.rmdirSync(path); }}Copy the code

   • inserve.jsFind the bodygenerateBook
   • Within the functionvar outputFolder = getOutputFolder(args);Write the following code on another line

     if (server.isRunning()) deleteFolder(outputFolder)
     Copy the code

   • Save and exit, restart Gitbook, and find that hot loading has taken effect

   Note:When you stop the service, if the service does not automatically delete the _book folder, you need to manually delete the _book folder` `

3. Gitbook not found after installationgitbookinstruction

   Need to add Gitbook variable Path Users\ Current User \AppData\Roaming\ NPM in your environmentCopy the code

4. usegitbook pdf . pdfname.pdfThe PEF file encoding is incorrect

   ① Download the installation package from https://calibre-ebook.com/ and install it locally ② Right-click the installation desktop icon to find the installation PATH and copy it ③ Right-click my computer -> Properties -> Advanced System Settings -> Environment Variables -> User Variables -> Select PATH -> Edit ④ Paste the file path to the blank line at the end of the file to save and exit. ⑤ Open CMD or another interactive window and run the gitbook commandCopy the code