mdbook
| _archive | ||
| books | ||
| collections | ||
| collections_beta | ||
| docs | ||
| heroscript | ||
| scripts | ||
| specs | ||
| .gitignore | ||
| hero_mdbook.sh | ||
| LICENSE | ||
| README.md | ||
| sshkey.md | ||
| sync_production.sh | ||
TFGrid Docs
Table of Contents
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
install hero as follows
curl https://raw.githubusercontent.com/freeflowuniverse/crystallib/development/scripts/installer_hero.sh | bash /tmp/hero_install.sh
you can also do it on a VM (experts only)
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.
Contribute
To contribute to this repository, make a pull request of your changes.
- Fork the repository and make a pull requests with your changes
- If you have access, create a new branch in this repo and make a pull request with your changes