web3privacy/docs
1
0
Fork 0
mirror of https://github.com/web3privacy/docs synced 2024-10-15 18:46:26 +02:00
Code Issues Projects Releases Packages Wiki Activity

update README

Browse source
This commit is contained in:
tree🌴 2023-11-10 15:40:30 +01:00
parent 27cc982051
commit 962efb7ea4
1 changed files with 4 additions and 39 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

43
README.md
View file

@ -1,41 +1,6 @@
# Website
# Web3Privacy Now Documentation
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
The documentation is based on the [Docusaurus 3](https://docusaurus.io/docs).
### Installation
```
$ yarn
```
### Local Development
```
$ yarn start
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
### Build
```
$ yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Deployment
Using SSH:
```
$ USE_SSH=true yarn deploy
```
Not using SSH:
```
$ GIT_USER=<Your GitHub username> yarn deploy
```
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
The production version can be found here:
* https://docs.web3privacy.info/