Skip to main content

🏁 Quick Start

For the impatient AKA all of us

Install Node​

To use Docusaurus we need to install Node.js

Clone this repo​

  • Clone this repo
git clone https://github.com/mongodb-developer/docusaurus-workshop
  • Rename the folder to the name of the workshop you want to write about
mv docusaurus-workshop name-of-my-new-awesome-workshop 
cd name-of-my-new-awesome-workshop

Remove .git directory​

As right now origin is pointing to https://github.com/mongodb-developer/docusaurus-workshop and you don't want that. Also, most probably you don't want this git repo's history.

rm -rf .git
git init
git add .
git commit -m "Initial version"

Install all dependencies​

npm install

Start it!​

npm start

Try it!​

Everything going according to plan, your site should be available at http://localhost:3000/name-of-my-new-awesome-workshop