podman-desktop/website
Stévan Le Meur 151bababa5
fix: update podman remote status command in documentation (#10474)
fix: replace podman remote status instruction

Signed-off-by: Stévan Le Meur <1636769+slemeur@users.noreply.github.com>
2024-12-24 16:08:18 +01:00
..
blog docs: fix release notes 1.15 (#10408) 2024-12-17 12:29:35 -05:00
docs fix: update podman remote status command in documentation (#10474) 2024-12-24 16:08:18 +01:00
src chore: add link to /extensions page on /extend (#10382) 2024-12-16 14:25:26 -05:00
static chore: release notes 1.15 (#10326) 2024-12-17 08:59:27 +01:00
tutorial docs(website): highlighted port forwarding through UI (#10006) 2024-11-21 15:29:58 +05:30
.gitignore chore: ignore generated files for release notes (#9035) 2024-09-24 08:12:47 -04: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 chore: change GitHub podman desktop links in website to podman-desktop org (#10340) 2024-12-16 11:58:45 -05:00
package.json chore(deps-dev): bump markdownlint from 0.37.1 to 0.37.2 2024-12-20 07:45:37 +01:00
README.md chore: switch to pnpm instead of yarn (#8589) 2024-08-29 20:13:01 +00:00
release-notes-parser.spec.ts chore: map release notes to their respective file names on GH (#8790) 2024-09-12 13:22:31 +00:00
release-notes-parser.ts chore: map release notes to their respective file names on GH (#8790) 2024-09-12 13:22:31 +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.spec.ts feat(eslint): enable vitest/no-identical-title (#9088) 2024-09-26 08:35:02 +00:00
storybook.ts feat(website): improve storybook sidebar (#9079) 2024-09-25 13:37:44 +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
vitest.config.js chore: map release notes to their respective file names on GH (#8790) 2024-09-12 13:22:31 +00: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