Getting Started

This page should contain information about the project you are currently in.

Go to Getting Started to see the checklist of things to do after cloning the repository.

The other pages in the "Tutorial - *" categories demonstrate how to use this engine to create documentation. They have been kept here for reference.

Running the Site

Run the development server:

cd docs
npm run start

The cd command changes the directory you're working with. In order to work with your Docusaurus site, you'll need to navigate to the docs folder.

The npm run start command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.

Open docs/docs/intro.mdx (this page) and edit some lines: the site reloads automatically and displays your changes.

Search Engine

Note: The search engine does not work when running via npm start. It requires building the site with npm run build and serving it via npm run serve.