mukulkhanna / gazebo-doc-index

A platform that brings together all of Gazebo's learning resources in one place, in an organised fashion, helping beginners and professionals to find the right help in terms of documentation content and resources quickly.

Gazebo Documentation Index

This repository contains code for Gazebo's documentation index.

Status: Under development

Getting started

Prerequisites

• Jekyll

Setup

git clone https://github.com/osrf/gazebo-doc-index.git
cd gazebo-doc-index
bundle exec jekyll serve

_categories

This folder is where information about all the categories is stored. Each file represents a category and contains information about sub-categories and items.

_layout

This folder stores the HTML layouts of the home page and the category page along with a wrapper layout that is the parent layout which includes the navbar and footer components.

_includes

This folder contains HTML code for the navbar and the footer.

Contribution guidelines

Refer to CONTRIBUTING.md for information about how to contribute to the project.