Apache Gravitino Website

This project is based on the ASF Docusaurus template.

Setup

To setup the initial website after checking out the code from GitHub:

pnpm install

Changing the site

To build the website use:

pnpm run build

To test the website use:

pnpm run serve

To clean the website use:

pnpm run clear

Generating a new docs version

pnpm gen:version 0.0.0

MDX/Markdown custom formatting syntax usage

Code blocks

Admonitions

Diagrams

Icon

Icon list

This is an icon <Icon icon='bx:x' fontSize='24px' />

Ideal Image use width

<Image img={require('./assets/xx/x.png')} style={{ width: 480 }} />

Video

<Video url='https://www.youtube.com/watch?v=dpkvYpDVgm4' />

Tabs

<Tabs>
  <TabItem value='tab1' label='Tab1' default>
    Tab1 content
  </TabItem>
  <TabItem value='tab2' label='Tab2'>
    Tab2 content
  </TabItem>
</Tabs>

or

<Tabs
  defaultValue='tab1'
  values={[
    { label: 'Tab1', value: 'tab1' },
    { label: 'Tab2', value: 'tab2' }
  ]}
>
  <TabItem value='tab1'>
    Tab1 content
  </TabItem>
  <TabItem value='tab2'>
    Tab2 content
  </TabItem>
</Tabs>

Highlight

<Highlight color='#fff' bg='#6877ef'>highlight</Highlight>

Deploy

A GitHub Actions workflow deploys the generated website content to the asf-site branch. It would work automatically.