Skip to content

Commit

Permalink
Update custom CSS and README
Browse files Browse the repository at this point in the history
  • Loading branch information
9inpachi committed May 28, 2024
1 parent 2ee5d7f commit d1bacb7
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 30 deletions.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,7 @@ const balance = await pufferClient.vault.balanceOf(walletAddress);

## Documentation

- Getting started
- Guides
Check the [documentation website](https://pufferfinance.github.io/puffer-sdk/) for detailed documentation and guides.

## Development

Expand All @@ -65,6 +64,18 @@ Start the package in watch mode.
pnpm dev
```

Setup linking so the package can be linked to other projects locally.

```sh
pnpm link --global
```

To link the package to a local project, run the following command.

```sh
pnpm link --global @pufferfinance/puffer-sdk
```

## Release

The release is automated using [release-it](https://github.com/release-it/release-it) and the [`publish.yml`](./.github/workflows/publish.yml) GitHub action. The action can be [dispatched manually](https://github.com/PufferFinance/puffer-sdk/actions/workflows/publish.yml) to make the release.
The release is automated using [release-it](https://github.com/release-it/release-it) and the [publish.yml](./.github/workflows/publish.yml) GitHub action. The action can be [dispatched manually](https://github.com/PufferFinance/puffer-sdk/actions/workflows/publish.yml) to make the release.
14 changes: 1 addition & 13 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,4 @@ This command generates static content into the `build` directory and can be serv

### Deployment

Using SSH:

```sh
USE_SSH=true pnpm docs:deploy
```

Not using SSH:

```sh
GIT_USER=<Your GitHub username> pnpm docs: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 deployment of the docs is automated with each release. See the [deploy-docs.yml](../.github/workflows/deploy-docs.yml) GitHub action.
28 changes: 14 additions & 14 deletions docs/src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,25 @@

/* You can override the default Infima variables here. */
:root {
--ifm-color-primary: #2e8555;
--ifm-color-primary-dark: #29784c;
--ifm-color-primary-darker: #277148;
--ifm-color-primary-darkest: #205d3b;
--ifm-color-primary-light: #33925d;
--ifm-color-primary-lighter: #359962;
--ifm-color-primary-lightest: #3cad6e;
--ifm-color-primary: #874fff;
--ifm-color-primary-dark: #7141d8;
--ifm-color-primary-darker: #5d36b3;
--ifm-color-primary-darkest: #492a8d;
--ifm-color-primary-light: #8f5ef8;
--ifm-color-primary-lighter: #a07af1;
--ifm-color-primary-lightest: #ac8dee;
--ifm-code-font-size: 95%;
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
}

/* For readability concerns, you should choose a lighter palette in dark mode. */
[data-theme='dark'] {
--ifm-color-primary: #25c2a0;
--ifm-color-primary-dark: #21af90;
--ifm-color-primary-darker: #1fa588;
--ifm-color-primary-darkest: #1a8870;
--ifm-color-primary-light: #29d5b0;
--ifm-color-primary-lighter: #32d8b4;
--ifm-color-primary-lightest: #4fddbf;
--ifm-color-primary: #41ff54;
--ifm-color-primary-dark: #3be74c;
--ifm-color-primary-darker: #31d141;
--ifm-color-primary-darkest: #28b136;
--ifm-color-primary-light: #66e973;
--ifm-color-primary-lighter: #78f084;
--ifm-color-primary-lightest: #88e692;
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
}

0 comments on commit d1bacb7

Please sign in to comment.