info_tfgrid/README.md

TFGrid Docs

Table of Contents

• Overview
• Basic Hero mdbook Commands
• Install and Use Hero
• Create a new mdbook
• Notes for Repo Owners

Overview

This repository contains TFGrid docs in the form of mdbooks generated with the Hero tool.

To see the whole list of books, check the heroscript directory.

Basic Hero mdbook Commands

Once Hero is set on your machine, you can run the following commands to preview mdbooks on your local browser:

• Pull new changes

  hero mdbook -u https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript/nameofyourbook -gp
  

• Build the book

  hero mdbook -u https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript/nameofyourbook
  

• Preview on a web browser

  hero mdbook -u https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript/nameofyourbook -o
  

Note: You can use -p instead of -u and set a path to your heroscript directory, as explained in the docs.

Install and Use Hero

To install and use Hero on a full VM running on the grid, read the full VM guide.

Create a new mdbook

To create a new mdbook, read the mdbook creation guide.

Notes for Repo Owners

todo: kristof some content does not belong here, move to other repo