Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
relliv committed Oct 2, 2024
1 parent 36dd551 commit a8d101b
Showing 1 changed file with 3 additions and 39 deletions.
42 changes: 3 additions & 39 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,5 @@
# Website
# nx-angular-svg-loaders

This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
[![SVG Loaders Preview](https://github.com/ngeenx/nx-svg-loaders/blob/main/docs/static/img/nx-svg-loaders-preview.gif?raw=true)](https://ngeenx.github.io/nx-svg-loaders/)

### 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.
Angular, React, Svelte, Vue SVG loader collection. Please check the **[documentation](https://ngeenx.github.io/nx-svg-loaders/)** for installation and usage.

0 comments on commit a8d101b

Please sign in to comment.