In this PR, I have installed Prettier, Husky & Lint-staged to make sure to unify the code format before committing. Also, I've configured it so that you can now run Docusaurus server locally with yarn start directly from the root directory, without needing to navigate to the /docs folder.
Changes
Installed yarn in the root directory
Added Prettier, Husky & Lint-staged
Formatted every single file with Prettier
Integrated the /docs directory with Yarn Workspaces
Modified .gitignore
Modified README.md to describe how to run Docusaurus server locally
Notes
Since I've integrated the /docs directory with Yarn Workspaces, now, running yarn from the root directory installs dependencies for both the root and the /docs directories at once.
Thus, you no longer need to navigate to the /docs directory to run Docusaurus server locally as follows.
Previously
Navigate to the /docs directory
cd docs
Install the dependencies
yarn
Start the Docusaurus development server
yarn start
From now on
Install the dependencies in the root directory
yarn
Start the Docusaurus development server from the root directory
yarn start
Assignee Checklist:
[x] The base branch is correct (no accidental merges)
Overview
In this PR, I have installed Prettier, Husky & Lint-staged to make sure to unify the code format before committing. Also, I've configured it so that you can now run Docusaurus server locally with
yarn start
directly from the root directory, without needing to navigate to the/docs
folder.Changes
yarn
in the root directoryPrettier
,Husky
&Lint-staged
Prettier
/docs
directory with Yarn Workspaces.gitignore
README.md
to describe how to run Docusaurus server locallyNotes
Since I've integrated the
/docs
directory with Yarn Workspaces, now, runningyarn
from the root directory installs dependencies for both the root and the/docs
directories at once.Thus, you no longer need to navigate to the
/docs
directory to run Docusaurus server locally as follows.Previously
Navigate to the
/docs
directoryInstall the dependencies
Start the Docusaurus development server
From now on
Install the dependencies in the root directory
Start the Docusaurus development server from the root directory
Assignee Checklist:
Reviewer Checklist