Tascurator / tascurator-documents

0 stars 0 forks source link

build: install prettier, husky & lint-staged #27

Closed akiomatic closed 8 months ago

akiomatic commented 8 months ago

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

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

  1. Navigate to the /docs directory

    cd docs
  2. Install the dependencies

    yarn
  3. Start the Docusaurus development server

    yarn start

From now on

  1. Install the dependencies in the root directory

    yarn
  2. Start the Docusaurus development server from the root directory

    yarn start

Assignee Checklist:

Reviewer Checklist