Article directory
Introduction
Gitbook is a platform that allows users to create and share content-rich online books. It has a user-friendly interface to quickly write, edit and publish your ebooks. Here is a basic steps to follow Gitbook
sync with github
1. Create a space
Open the GitBook official website , here I choose to use the github account to log in, of course you can also create a new account yourself
Click the plus sign in the lower left corner and choose New spaceto create a new Gitbook space
2. Install the github plugin
Click above integrationsand selectGithub Files
Click Installto install the github plugin
After installing the plug-in, you need to click Authorizeto grant gitbook and github synchronization permission, and then a browser box will pop up (you may need to log in to your github), clickAuthorize GitbookIO
3. Synchronize github
Return to the space page, click Sync with Githubto indicate that this space will be synchronized with github
where Synchronize with Git, Providertick theGithub
at Configuration, click Connect with Github, and selectInstall Github application
The pop-up page allows you to install Gitbook, clickInstall
Select your Github account, repository and branch, then click synchronizeStart Synchronization
The synchronization is completed as shown in the figure below
4. Generate space url
You can see in the space that the content of the github article has been synchronized to gitbook. If you want others to see it, you need to click on the upper right cornerShare
Publish to the webCheck here , Publish this space to the weband then it will generate the url link of your note, for example, here I am https://aptboys.gitbook.io/demo1
Access the generated url link, the effect is as shown in the figure below
Blog Building Guide
1. Custom domain name
Click the setting option of the organization you created, for example, the organization I created here is AptBoys, I will clickAptBoys Settings
Find it in the General option block Custom domain, click Edit domainCustomize the domain name of your blog
Fill in your third-level domain name, for example, here is mine www.henry666.xyz, the domain name henry666.xyzis applied on godaddy (no domain name registration required)
Add the fields of the DNS record and their corresponding values to the DNS management record of your domain name. The dns record to be added here is www of CNAME type, pointing to the gitbook URL
The final step is to verify that your domain name is configured correctly
2. Publish blog content
Created Collectionand can be used to store multiple spaces, which is convenient for synchronizing with articles in the github repository
Publish the created collection to the web
The next step is very important. The space in the collection needs to be published on the Web. Here, selectPublish in collection
The final blog effect is shown in the figure below:
3. Set the domain name default page
Go to the settings page, find Default Contentand click to Change default contentmodify the default domain name page
Select the Collection you created earlier
When you visit your domain name, you will be redirected to Collectionthe page. For example, if I visit my domain name www.henry666.xyz, it will automatically jump towww.henry666.xyz/henryblog/
4. Interface settings
Click Collection CustomizationCustomize Blog Interface, Title&Iconyou can set your blog title and display icon, and you can see the modified blog interface in real time in the left column
Default spaceYou can set the default space of the blog and Themesset the theme of the blog
ConfigureYou can check it here to Enable lens semantic searchstart the AI search engine
Precautions
1. The markdown file name of the github warehouse is best not to have spaces. In other words, the file directory where you store pictures cannot have spaces, so that your picture files cannot be displayed on the page.
2. Let’s write when we meet later, hee hee