Skip to content

Latest commit

 

History

History
64 lines (45 loc) · 1.79 KB

README.md

File metadata and controls

64 lines (45 loc) · 1.79 KB
Raw

Nocalhost Docs & Website

This repository contains the source code of Nocalhost website and all documentations. It's built by Docusaurus 2.

Preview

Clone the repository to your local workstation.

Installation

npm install

Local Development

npm run start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Add or Update Docs

When you add or modify the docs, these three files(docs, static and sidebars.js) should be taken into consideration.

  1. docs/, the main English documentation files are mainly located in this folder. All markdown files need to follow the format, that the title at the beginning should be in the following format:
---
title: Title Name
---
  1. static, contains all the static files like image, stylesheet and fonts. We are using mdx format for image resources, please read the official docs of docusaurus to lean the markdown features.
<figure className="img-frame">
  <img className="gif-img" src={useBaseUrl('/img/installation/vscode-market.png')} />
  <figcaption>VS Code Extension Market</figcaption>
</figure>
  1. sidebars.js, this file contain the navigation information of the KubeVela website. Please read the official docs of docusaurus to learn how to write sidebar.js.
    {
      type: 'category',
      label: 'Getting Started',
      collapsed: false,
      items: [
        'quick-start',
        'installation',
      ]
    },