tfgrid/info_tfgrid
38
3
Fork 0
Code Issues 12 Pull Requests Packages Projects 3 Releases Activity
mdbook
258 Commits 4 Branches 0 Tags 817 MiB
HTML 43.9%
Shell 37.2%
Mermaid 14.6%
V 3.5%
Makefile 0.8%
ea34074571
Go to file
mik-tf ea34074571 hero docs added info on building updated book
2024-04-17 15:24:28 +00:00
_archive ... 2024-03-18 14:28:08 +02:00
books manual added scripts data 2024-04-16 19:52:15 +00:00
collections manual added scripts data 2024-04-16 19:52:15 +00:00
docs hero docs added info on building updated book 2024-04-17 15:24:28 +00:00
heroscript Merge branch 'main' of git.ourworld.tf:tfgrid/info_tfgrid 2024-04-16 04:46:33 -03: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 readme 2024-04-16 07:26:11 -03: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

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.

  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