public/rancher-docs
1
0
Fork 0
mirror of https://github.com/rancher/rancher-docs.git synced 2026-09-26 04:58:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

more revisions to README

Browse Source
This commit is contained in:
Marty Hernandez Avedon
2023-01-09 17:38:34 -05:00
committed by GitHub
parent c3c6759ae8
commit 610bc32520
1 changed files with 13 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+13 -13
View File
@@ -16,11 +16,11 @@ title: Some Title
---
```
The title metadata is rendered as the published page's headline. The renderer wraps the content of the `title` in H1 level HTML header tags, which are equivalent to `#` in Markdown syntax. This means that all subsequent headers on the page should be second level (`##`) or more.
The title metadata is rendered as the page's headline. The renderer wraps the `title` value in H1 tags, which are equivalent to `#` in Markdown syntax. This means that all subsequent headers on the page should be second level (`##`) or more.
## Organization
Folders and directories in the repo correspond to submenus in the site sidebar. We try to keep our submenus to a maximum of three levels deep, or four if absolutely necessary.
Directories in the repo correspond to submenus in the site sidebar. We try to keep our submenus to a maximum of three levels deep, or four if absolutely necessary.
The sidebar on the live site is rendered based on the contents of the file `sidebar.json`, which is located in the top level of the repository. If you add, move, or delete a page, `sidebar.json` must be updated.
@@ -36,15 +36,7 @@ First, install Docusaurus 2:
1. Go into your local rancher-docs folder.
1. The Rancher Docs repository already contains a yarn.lock file, which contains the dependencies you need to build the website. Run `yarn` to install Docusaurus and associated dependencies.
### Launch With Docker
Use [Docker](https://www.docker.com/) 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
```
### Start
### Start Site
```
yarn start
@@ -54,7 +46,7 @@ This command starts a local development server for Docusuarus 2, and opens up a
Note: The `yarn start` command won't include some important static site features. For example, the site will lack versioning for different languages. If you need these features, use `yarn build`.
### Build
### Build Site
```
yarn build
@@ -62,6 +54,14 @@ yarn build
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Launch With Docker
Use [Docker](https://www.docker.com/) 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
```
License
=======
Copyright (c) 2014-2022 [Rancher Labs, Inc.](https://rancher.com)
@@ -76,4 +76,4 @@ 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.
limitations under the License.