Tigerbotics Megadocs

This is the source code for Tigerbotic's documentation, accessable here.

Local Setup

This project is built on Next.js. You can run it on your machine, provided you have Node.js and pnpm installed locally.

If you need to install Node.js and pnpm, you can use their links above to go to their respective download / installation pages.

First, clone the repo:

git clone https://github.com/tigerbotics7125/megadoc.git

Change directory (cd) into the folder:

cd docs

Install dependencies:

pnpm install

Then, run the project:

pnpm run dev

You can then visit http://localhost:3000 to see it in action.

Writing documentation

The site is generated using Nextra, their guide will have the most information about how this project works, you can find it here.

The following will explain the basics however:

• The site is automatically generated with files that are in the pages/ folder.

  • These files typically end in .md or .mdx (Nextra supports other formats, but it is not as intuitive as plain Markdown).

    • .md files are Markdown files, you can find documentation on how to write in basic Markdown here.

    • .mdx files are also Markdown, but they allow for extra front end logic using React components, you can find more info about MDX here.

      • You should install a MDX language extension for VSCode such as this one if you plan to use MDX files.

• Images are stored in the public/ folder.

  • Nextra automatically optimizes your images when using the Markdown syntax. You do not need to specify the width and height of the image, just use the Markdown syntax:

  ![Image Name](/image.png)