2024-04-02 20:46:28 +00:00
< h1 > TFGrid Docs< / h1 >
2024-02-05 02:49:16 +00:00
2024-04-02 20:46:28 +00:00
< h2 > Table of Contents< / h2 >
2024-02-05 09:44:04 +00:00
2024-04-02 20:46:28 +00:00
- [Overview ](#overview )
- [Basic Hero mdbook Commands ](#basic-hero-mdbook-commands )
- [Install and Use Hero ](#install-and-use-hero )
- [Create a new mdbook ](#create-a-new-mdbook )
- [Notes for Repo Owners ](#notes-for-repo-owners )
2024-03-22 17:08:46 +00:00
2024-04-02 20:46:28 +00:00
## Overview
2024-03-22 17:08:46 +00:00
2024-04-02 20:46:28 +00:00
This repository contains TFGrid docs in the form of mdbooks generated with the [Hero ](https://github.com/freeflowuniverse/crystallib/tree/development/cli/hero ) tool.
2024-03-22 17:08:46 +00:00
2024-04-02 20:46:28 +00:00
To see the whole list of books, check the [heroscript directory ](./heroscript ).
2024-03-22 17:08:46 +00:00
2024-04-02 20:46:28 +00:00
## Basic Hero mdbook Commands
2024-03-22 17:08:46 +00:00
2024-04-02 20:46:28 +00:00
Once Hero is set on your machine, you can run the following commands to preview mdbooks on your local browser:
2024-03-22 17:08:46 +00:00
2024-04-02 20:46:28 +00:00
- Pull new changes
```
hero mdbook -u https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript/nameofyourbook -gp
```
2024-03-22 17:08:46 +00:00
2024-04-02 20:46:28 +00:00
- 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](./docs).
## Install and Use Hero
To install and use Hero on a full VM running on the grid, read the [full VM guide ](./docs/hero_fullvm.md ).
## Create a new mdbook
To create a new mdbook, read the [mdbook creation guide ](./docs/hero_create_mdbooks.md ).
## Notes for Repo Owners
> todo: kristof some content does not belong here, move to other repo