Skip to content

AlgoGators/AlgoGators.github.io

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AlgoGators Documentation

The AlgoGators documention can be view here. The documention has been built with the mdBook tool that allows for straightforward documention hosting.

Dev Rules

When making contributions to the "AlgoBook" work with a development branch off of a greater development branch of off of main. Understand when merging with main, you will kick-off the building and deployment workflows.

Installation

To use and view the documentation, install mdBook either through cargo or a pre-compiled binary. The process of installation is within mdBooks documention.

Local Viewing

To host and view the documentation, you must have mdBook installed.

To build:

mdbook build

And to serve:

mdbook serve --open

About

Documentation of AlgoGators and internal systems

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages