podman-desktop/website
dependabot[bot] 8aefc9d03a chore(deps-dev): bump typedoc from 0.26.6 to 0.26.7
Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.26.6 to 0.26.7.
- [Release notes](https://github.com/TypeStrong/TypeDoc/releases)
- [Changelog](https://github.com/TypeStrong/typedoc/blob/master/CHANGELOG.md)
- [Commits](https://github.com/TypeStrong/TypeDoc/compare/v0.26.6...v0.26.7)

---
updated-dependencies:
- dependency-name: typedoc
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-09-09 12:28:04 +02:00
..
blog docs: update podman gpu image (#8551) 2024-08-22 13:59:15 +00:00
docs docs(website): configuring kube objects (#8545) 2024-09-09 03:34:59 +00:00
src feat(website): enhance doc sidebar (#8730) 2024-09-06 09:01:03 -04:00
static docs: update podman gpu image (#8551) 2024-08-22 13:59:15 +00:00
.gitignore feature(website): storybook docusaurus integration (#7648) 2024-06-24 11:20:37 +02:00
.prettierignore fix: website check targets 2023-06-27 11:19:06 +02:00
babel.config.js feat: adds initial website built from docusaurus 2022-04-04 17:23:17 +02:00
docusaurus.config.js fix: storybook svelte 5 2024-08-19 12:29:52 +02:00
package.json chore(deps-dev): bump typedoc from 0.26.6 to 0.26.7 2024-09-09 12:28:04 +02:00
README.md chore: switch to pnpm instead of yarn (#8589) 2024-08-29 20:13:01 +00:00
sidebars-api.js chore: add missing copryright headers in files 2024-03-15 11:53:23 +01:00
sidebars.js chore: add missing copryright headers in files 2024-03-15 11:53:23 +01:00
storybook.ts feat: enhance storybook sidebar on website (#8594) 2024-08-28 16:47:51 +02:00
tailwind.config.js fix: website is using the new palette colors but definition are not there 2023-05-09 10:42:46 +02:00
tsconfig.json fix: enable strict rule on website (#7447) 2024-06-05 09:56:20 +02:00

Website

Install the project dependencies

$ pnpm install

Local Development of the website / documentation

$ pnpm 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

$ pnpm 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 pnpm deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> pnpm 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.

Adding a Node.js module to the website

  1. Add the module in the website context:

    $ cd website
    $ pnpm add <module>
    
  2. Update the pnpm-lock.yaml file in the repository root context:

    $ cd ..
    $ git checkout HEAD -- pnpm-lock.yaml
    $ pnpm install