podman-desktop/website
dependabot[bot] c3537d2675 chore(deps-dev): bump typedoc-plugin-markdown
Bumps [typedoc-plugin-markdown](https://github.com/tgreyuk/typedoc-plugin-markdown/tree/HEAD/packages/typedoc-plugin-markdown) from 4.0.0-next.52 to 4.0.0-next.53.
- [Release notes](https://github.com/tgreyuk/typedoc-plugin-markdown/releases)
- [Changelog](https://github.com/tgreyuk/typedoc-plugin-markdown/blob/typedoc-plugin-markdown@4.0.0-next.53/packages/typedoc-plugin-markdown/CHANGELOG.md)
- [Commits](https://github.com/tgreyuk/typedoc-plugin-markdown/commits/typedoc-plugin-markdown@4.0.0-next.53/packages/typedoc-plugin-markdown)

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

Signed-off-by: dependabot[bot] <support@github.com>
2024-02-09 11:59:34 +01:00
..
blog docs: added link to the troubleshooting page (#5734) 2024-01-29 14:37:34 -05:00
docs chore: rename developing 2024-01-31 09:40:14 -05:00
src chore: fix color of server-side download button 2024-02-01 07:51:10 -05:00
static feat: add blog post about wasm (#4506) 2024-01-29 10:30:23 +00:00
.eslintignore fix: website check targets 2023-06-27 11:19:06 +02:00
.gitignore docs: using typedoc to generate api documentation (#5705) 2024-02-01 10:48:07 +01: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 docs: using typedoc to generate api documentation (#5705) 2024-02-01 10:48:07 +01:00
package.json chore(deps-dev): bump typedoc-plugin-markdown 2024-02-09 11:59:34 +01:00
README.md chore: added @docusaurus/plugin-client-redirects (#3731) 2023-08-31 16:51:44 +02:00
sidebars-api.js docs: using typedoc to generate api documentation (#5705) 2024-02-01 10:48:07 +01:00
sidebars.js chore: enhanced sidebar and navigation (#1302) 2023-02-22 10:58:57 +01: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 chore: update to docusaurus v3.0.0 (#4764) 2023-11-22 15:09:06 +00:00

Website

Install the project dependencies

$ yarn install

Local Development of the website / documentation

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

Adding a Node.js module to the website

  1. Add the module in the website context:

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

    $ cd ..
    $ git checkout HEAD -- yarn.lock
    $ yarn