tfgrid/info_tfgrid
30
3
Fork 0
Code Issues Pull Requests 1 Packages Projects Releases Activity
mdbook
217 Commits 5 Branches 0 Tags 757 MiB
HTML 58.9%
Shell 27%
Mermaid 10.9%
V 2.6%
Makefile 0.6%
52eff1e6fc
Go to file
mik-tf 52eff1e6fc updated intro and ecosystem
2024-04-10 23:13:08 +00:00
_archive ... 2024-03-18 14:28:08 +02:00
books updated intro and ecosystem 2024-04-10 23:13:08 +00:00
collections updated intro and ecosystem 2024-04-10 23:13:08 +00:00
docs Update docs/hero_create_mdbook.md 2024-04-03 13:05:21 +00:00
heroscript Merge branch 'main' of git.ourworld.tf:tfgrid/info_tfgrid 2024-04-05 07:43:20 +02:00
scripts Update scripts/hero_mdbook.sh 2024-02-22 15:04:48 +00:00
specs ... 2024-03-18 14:28:08 +02:00
.gitignore ... 2024-01-26 06:06:57 +03:00
LICENSE ... 2024-01-26 06:06:57 +03:00
README.md Update README.md 2024-04-10 20:20:52 +00:00
sshkey.md ... 2024-02-05 12:51:02 +03:00
sync_production.sh .. 2024-03-19 08:28:25 +02:00

README.md

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

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.

  1. Fork the repository and make a pull requests with your changes
  2. If you have access, create a new branch in this repo and make a pull request with your changes