Update 'README.md'
This commit is contained in:
parent
984bfd6a1b
commit
47ed9d47d5
22
README.md
22
README.md
|
@ -2,33 +2,37 @@
|
|||
|
||||
This website is built using [Docusaurus 2](https://docusaurus.io/); please check [here](https://docusaurus.io/docs/installation#requirements) the requirements to run the project.
|
||||
|
||||
## Clone repository
|
||||
```
|
||||
git clone https://code-repo.d4science.org/D-Net/openaire-graph-docs.git
|
||||
```
|
||||
|
||||
## Local installation and deployment
|
||||
|
||||
## Local installation and development
|
||||
|
||||
From https://docusaurus.io/docs/installation#requirements
|
||||
> Node.js version 16.14 or above (which can be checked by running node -v)
|
||||
|
||||
Clone the repository:
|
||||
```
|
||||
git clone https://code-repo.d4science.org/D-Net/openaire-graph-docs.git
|
||||
```
|
||||
NOTE: please use git branches for introducing new changes.
|
||||
|
||||
|
||||
To install the required packages use:
|
||||
Install the required packages:
|
||||
```
|
||||
npm install
|
||||
```
|
||||
|
||||
The following command starts a local development server and opens up a browser window. Note that most changes are reflected live without having to restart the server.
|
||||
Start a local development server (opens in a new browser window).
|
||||
```
|
||||
npm run start
|
||||
```
|
||||
NOTE: most changes are reflected live without having to restart the server.
|
||||
|
||||
Generate the static content into the `build` directory using the command tha follows. Then this directory can be served using any static contents hosting service.
|
||||
|
||||
Before issueing a Pull Request, please ensure that the following command runs successfully:
|
||||
```
|
||||
npm run build
|
||||
```
|
||||
NOTE: This command generates the static content into the `build` directory.
|
||||
Then this output directory is issued to deploy the documentation website.
|
||||
|
||||
## Deployment using Docker
|
||||
|
||||
|
|
Loading…
Reference in New Issue