How to deploy your own website using mdBook

May 29, 2023#github #action #mdbook529

AI Translation

This post is translated from Chinese into English through AI.View Original

AI-generated summary

mdBook is a static site generator based on Markdown files that can be used to quickly create personal blogs, documentation pages, or websites. The steps to deploy your own website using mdBook are as follows: 1. Install mdBook by downloading the latest version from the mdBook GitHub page and following the official documentation for installation. 2. Create an mdBook project on your local computer using the command "mdbook init mysite" to create a new project named "mysite" in the current directory. 3. Write Markdown files in the "src" folder of the mdBook project, which will be automatically converted into HTML pages. You can use Markdown syntax to write document content and mdBook's special syntax to set page layout and add navigation. 4. Preview the generated site locally using the command "mdbook serve --open" to start a local server and view the site in a browser at http://localhost:3000. 5. Build the final static website files using the command "mdbook build" when you are satisfied with the appearance and content of the site. This will generate a folder named "dist" containing the generated HTML, CSS, JavaScript, and other files. 6. Deploy the website by uploading the generated "dist" folder to your web server or static hosting platform such as GitHub Pages or Netlify. 7. After uploading your repository to GitHub, go to the repository's settings and find the "Pages" section. Configure the source to use GitHub Actions for build and deployment. 8. Use the default configuration provided by mdBook for the GitHub Actions setup. 9. After committing the code, wait for the GitHub Actions to finish running, and you will have your own website homepage.

mdBook is a static site generator based on Markdown files, which can be used to quickly create personal blogs, documentation pages, or websites. Here are the brief steps to deploy your own website using mdBook:

Install mdBook: Go to the GitHub page of mdBook to download the latest version of mdBook, and follow the official documentation for installation.
Create mdBook project: Create a new mdBook project on your local computer using the following command:
```
mdbook init mysite
```
This will create a new project named "mysite" in the current directory.
Write Markdown files: Write Markdown-formatted documents in the "src" folder of the mdBook project. These documents will be automatically converted into HTML pages. You can use Markdown syntax to write document content, as well as some special syntax provided by mdBook to set page layout, add navigation, etc.
Preview the site: Preview the generated site locally using the following command:
```
mdbook serve --open
```
This will start a local server that allows you to preview the generated site in your browser. You can access it by visiting http://localhost:3000.
Build the website: When you are satisfied with the appearance and content of the site, use the following command to build the final static website files:
```
mdbook build
```
This will generate a folder named "dist" that contains the generated HTML, CSS, JavaScript, and other files.
Deploy the website: Upload the generated "dist" folder to your web server or static hosting platform, such as GitHub Pages, Netlify, etc., to deploy your website on the internet.