From 30ed739b05879493156336a121311c4e9278e7e8 Mon Sep 17 00:00:00 2001 From: mik-tf Date: Wed, 17 Apr 2024 15:19:11 +0000 Subject: [PATCH 1/2] hero docs, added include and parentheses info --- docs/hero_mdbook_fullvm.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/hero_mdbook_fullvm.md b/docs/hero_mdbook_fullvm.md index b0dd677..fddb496 100644 --- a/docs/hero_mdbook_fullvm.md +++ b/docs/hero_mdbook_fullvm.md @@ -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' + ``` \ No newline at end of file From ea34074571efe70f7b9e4ec589db9f6cd67b7012 Mon Sep 17 00:00:00 2001 From: mik-tf Date: Wed, 17 Apr 2024 15:24:28 +0000 Subject: [PATCH 2/2] hero docs added info on building updated book --- docs/hero_create_mdbook.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/docs/hero_create_mdbook.md b/docs/hero_create_mdbook.md index 8cb9ce6..d662bd2 100644 --- a/docs/hero_create_mdbook.md +++ b/docs/hero_create_mdbook.md @@ -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 -``` \ No newline at end of file +- 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 + ``` \ No newline at end of file