mirror of
https://github.com/rancher/rancher-docs.git
synced 2026-04-17 03:45:39 +00:00
63 lines
1.6 KiB
Markdown
63 lines
1.6 KiB
Markdown
# Website
|
|
|
|
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
|
|
|
|
### Installation
|
|
|
|
```
|
|
$ yarn
|
|
```
|
|
|
|
### Local Development
|
|
|
|
```
|
|
$ 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.
|
|
|
|
You can also use Docker to launch the website without needing to install and configure yarn:
|
|
|
|
```
|
|
docker run --rm -it -v $PWD:$PWD -w $PWD -p 3000:3000 node yarn start -h 0.0.0.0
|
|
```
|
|
|
|
### 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.
|
|
|
|
License
|
|
=======
|
|
Copyright (c) 2014-2022 [Rancher Labs, Inc.](https://rancher.com)
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License. |