Add final pieces of content to the book

This commit is contained in:
James Skemp 2021-09-06 17:32:14 -05:00
parent c9752e6dc3
commit f74c3e409e
4 changed files with 19 additions and 0 deletions

View File

@ -8,3 +8,5 @@
- [Step 4: GitLab repository](./step_4.md)
- [Step 5: Book TOML](./tweaks/toml.md)
- [Step 6: gitlab-ci](./step_6.md)
- [Step 7: Viewing your mdBook on GitLab Pages](./step_7.md)
- [Step 8: Wrapping up](./wrapping-up.md)

View File

@ -18,3 +18,8 @@ This will automatically create a new `intro.md` file with the title of Introduct
git add .
git commit -m "Add message summary"
```
## Manually adding a page
You can also manually add a page by creating a new Markdown file and then updating the SUMMARY.md file to point to it. You can nest files in folders, as well as create subchapters.
See [SUMMARY.md in the mdBook Documentation](https://rust-lang.github.io/mdBook/format/summary.html) for more information.

6
src/step_7.md Normal file
View File

@ -0,0 +1,6 @@
# Step 7: Viewing your mdBook on GitLab Pages
Once you've published your .gitlab-ci.yml file, or have submitted a change, you'll be able to see the status of the new deployment on both the repository main page and the CI/CD > Pipelines page.
Assuming everything is setup correctly you can navigate to Settings > Pages in GitLab and you'll see the URL of the mdBook you've just created. In this case it's at https://strivinglife.gitlab.io/book-gitlab-mdbook/.
This is also where you can setup a custom domain if you have and would like to use one.

6
src/wrapping-up.md Normal file
View File

@ -0,0 +1,6 @@
# Step 8: Wrapping up
With that, you've now created a mdBook and have it hosted for free on GitLab Pages.
You can make edits to the book both locally as well as on GitLab itself by editing or creating new pages. Once you commit your changes GitLab will automatically generate an updated site.
See [the official mdBook Documentation](https://rust-lang.github.io/mdBook/index.html) for more information and advanced techniques.