Skip to content

FIT3170-FY-Project-7/RABIT-DOCS

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

75 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitHub Octicons: Book RABIT-DOCS

License Badge GitHub pull requests GitHub issues



This repository contains the source code (and output pages) for RABIT documentation.


Editing, Building, Local Deployment

  1. Install mdBook by following the installation guide.
  2. To add more pages, create a new .md file in the src folder, and add an entry in SUMMARY.md. See the mdBook docs for the syntax.
  3. To build and see the output locally, run mdbook serve and go to http://localhost:3000.

Production Deployment

  • You cannot edit directly in main branch, so you'll need to create a new branch or fork the repo for non-collaborators.
  • When you're ready, just create a pull request. Once merged, it will be built and deployed automatically to github pages.
  • Note: You should NOT edit or branch from the gh-pages branch.

To learn more about contributing see the documentation.