https://github.com/eclipse-xpanse/xpanse-website
Sourcecode for Eclipse Xpanse project website. Website is hosted on Eclipse Foundation's infrastructure.
https://github.com/eclipse-xpanse/xpanse-website
docusaurus typescript website-development
Last synced: 5 months ago
JSON representation
Sourcecode for Eclipse Xpanse project website. Website is hosted on Eclipse Foundation's infrastructure.
- Host: GitHub
- URL: https://github.com/eclipse-xpanse/xpanse-website
- Owner: eclipse-xpanse
- License: apache-2.0
- Created: 2023-03-13T08:18:41.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-12-22T21:05:54.000Z (6 months ago)
- Last Synced: 2025-12-24T10:25:13.608Z (6 months ago)
- Topics: docusaurus, typescript, website-development
- Language: TypeScript
- Homepage:
- Size: 47.7 MB
- Stars: 6
- Watchers: 4
- Forks: 7
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
- Support: docs/supported-clouds.mdx
Awesome Lists containing this project
README
# xpanse Website
[](https://github.com/eclipse-xpanse/xpanse-website/actions/workflows/xpanse-website-ci.yml) [](https://github.com/eclipse-xpanse/xpanse-website/actions/workflows/xpanse-website-cd.yml)
xpanse website is built using [Docusaurus 3](https://docusaurus.io/), a modern static website generator.
## Installation
```
$ npm
```
## Local Development
```
$ npm 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.
## Production Deployment
The website is currently deployed on Eclipse Foundation's infrastructure.
All changes that are pushed to `main` branch will trigger a re-deployment of the website.
In case the website needs to be deployed anywhere else, then run the below command and copy the contents generated in the
`build` folder to any server that can server static websites.
```shell
npm run build
```
## Icons
Free icons on this website are taken from [Lucide](https://lucide.dev/).
## Dependencies File
All third-party related content is listed in the [DEPENDENCIES](DEPENDENCIES) file.
## Vale Linter
We use [Vale Linter](https://vale.sh/) for our documentation validation. The linter is part of the CI job and any finding will make the job to fail.
### Running Vale Linter Locally
To run the Vale linter locally, we must download the rules packages manually to `.github/vale/styles` folder as mentioned below.
```shell
copy files from https://github.com/errata-ai/packages/tree/master/pkg/Google/Google to .github/vale/styles/Google
copy files from https://github.com/errata-ai/packages/tree/master/pkg/Microsoft/Microsoft to .github/vale/styles/Microsoft
```
Execute the linter by running the following commands
```shell
docker run --rm -v $(pwd)/.github/vale/styles:/styles --pull=always --rm -v $(pwd):/docs -w /docs jdkato/vale .
```