This commit is contained in:
mik-tf 2024-04-17 17:20:52 +00:00
commit 1ae78c8b19
2 changed files with 20 additions and 6 deletions

View File

@ -165,10 +165,13 @@ git push
## Generating the mdbook from a Remote Repository
Once the changes are uploaded to the remote repository, you will be able to build and open the new mdbook using the remote repository URL:
Once the changes are uploaded to the remote repository, you will be able to update the local repository and build the new mdbook using the remote repository URL:
```
hero mdbook -u https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript/new_mdbook -gr
hero mdbook -u https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript/new_mdbook
hero mdbook -u https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript/new_mdbook -o
```
- Update the repository
```
hero mdbook -u https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript/new_mdbook -gr
```
- Build the book
```
hero mdbook -u https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript/new_mdbook -o
```

View File

@ -11,6 +11,7 @@
- [Troubleshooting](#troubleshooting)
- [Fix the error: "cli execution error: Cannot pull repo..."](#fix-the-error-cli-execution-error-cannot-pull-repo)
- [Fix: Git hangs at "Cloning into..."](#fix-git-hangs-at-cloning-into)
- [Distinctions between mdbook and hero mdbook](#distinctions-between-mdbook-and-hero-mdbook)
***
@ -154,3 +155,13 @@ If it happens another time, you can try to download it manually:
mkdir -p /root/code/git.ourworld.tf/tfgrid && cd $_
git clone https://git.ourworld.tf/tfgrid/info_tfgrid
```
## Distinctions between mdbook and hero mdbook
There are some distinctions between mdbook and hero mdbook. This is subject to change since hero is being continually improved and developed.
- hero mdbook cannot use parenthesis in tables of contents (e.g. in SUMMARY.md)
- hero mdbook uses the following include template:
```
!!wiki.include page:'collection_name:file_name.md'
```