asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: modified README files (#4782)

Browse Source
This commit is contained in:
Shahed Nasser
2023-08-16 17:12:42 +03:00
committed by GitHub
parent 9165f3214b
commit 8336e2002a
3 changed files with 17 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/docs/README.md
+2 -10
View File
@@ -1,14 +1,6 @@
# Website
# Medusa Documentation
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
## Note Before Development
If you have installed the dependencies in the root of this repository (in other words, if you have a `node_modules` directory at the root of this repository), this will cause an error when running this documentation website. This is because the content resides in `docs/content` and when that content is being imported from there, a mix up can happen between the dependencies which will cause an `invalid hook call` error.
For that reason, the `clean-node-modules` script was added that deletes the `node_modules` directory. The script is called that script before the `start` and `build` scripts are ran.
So, everytime you run these two scripts, the `node_modules` directory at the root will be deleted.
The Medusa documentation website is built with Docusaurus v2. You can learn more about contributing [here](https://docs.medusajs.com/contribution-guidelines).
## Components and Theme