Website
Overview
This repository contains website source for kyma-project.io
. The website uses GatsbyJS for static site generation and is deployed by Netlify.
NOTE: The project structure, architecture, and other project-specific details are located in the
docs
directory.
Prerequisites
Use the following tools to set up the project:
- Node.js v12.20.1
If your Node is in a different version than required, install NVM to switch to an older version.
Usage
Install dependencies
To install all dependencies, run this command:
npm install
Launch the website locally
Launch the development server with the hot reloading functionality that allows any change in files in the src
folder to be immediately visible in the browser. Run the following command:
npm run develop
To fetch docs
locally from the Kyma
repository, go to the scripts/prepare-content.sh
file and change APP_DOCS_OUTPUT
to:
APP_DOCS_OUTPUT="{FULL_PATH_TO_REPOSITORY}/content/docs"
Then go to the root directory of the repository and run the following command:
make prepare-content-website
To debug and develop the process of fetching content, go to the tools/content-fetcher
directory and run the following command:
npm start
Build the production-ready website
To build a production-ready website, run the following command:
npm run build
Run the server with the production-ready website
To serve a production-ready website, run the following command:
npm run serve
Test the website
To run unit tests, run the following command:
npm run test
Validate the website
To validate TypeScript types as well as document and code linting on the website, run the following command:
make validate