# openwharf-group.github.io

**Repository Path**: heimanba/openwharf-group.github.io

## Basic Information

- **Project Name**: openwharf-group.github.io
- **Description**: No description available
- **Primary Language**: JavaScript
- **License**: Apache-2.0
- **Default Branch**: login
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-11-04
- **Last Updated**: 2023-11-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Openwharf Official Website

### Quick Start

1. `npm install`

2. `npm run start`

3. Visit
```
localhost:3000/
```

### Build

1. `npm run build`

2. `npm run serve`

3. Visit
```
localhost:3000/
```

## Requirements
Base docusaurus v2.3.1
Node.js version 16.14+

## Note for i18n
For now, we use [docusaurus](https://www.zhihu.com/people/erda-project) `v2.3.1`, and there is a problem with `defaultLocale` in `docusaurus.config.js`. We can't deploy site like `https://my-site`, [see this](https://github.com/facebook/docusaurus/discussions/8745).

It will be solved perfectly in `v2.4`, stay tuned.

Please be noted that locale switching function doesn't work if you start the website in development mode using `npm run start` or `npm run start-en`. Please run it in production mode using the build-and-serve process to enable the locale switching function.

## How To Write Documents

### Add a new doc
 
1. Add new .md file under i18n/en-us/docusaurus-plugin-content-docs/current or i18n/zh-cn/docusaurus-plugin-content-docs/current. Corresponding to Chinese file and English file , and the Chinese and English file names should be consistent.
2. Update sidebar.js, add a new entry to the blog in either en-us or zh-cn.

### Add a new article for developers

1. Add new .md file under i18n/en-us/docusaurus-plugin-content-docs/current/developers or i18n/zh-cn/docusaurus-plugin-content-docs/current/developers, the file name should end up with _dev.md. Note that the suffix _dev is necessary.
2. Update sidebar.js, add a new entry in either en-us or zh-cn.

### Add a new blog

1. Add new .md file under i18n/en-us/docusaurus-plugin-content-blog/current or i18n/zh-cn/docusaurus-plugin-content-blog/current. Corresponding to Chinese file and English file , and the Chinese and English file names should be consistent.
2. `SEO` config is required.

## SEO

the type is :
```
---
title: title
keywords: [keywords1,keywords2]
description: some description
author: author name
date: 2018-12-29
---
```
**Note:**
1. `title` can not include `:` 
2. `keywords` must be a `Array`
3. `custom_edit_url` is a link to the doc in this repo, required.

## Note for .md file
1. Do not use un correct html tag like `<img>、<br>`, replace with `<img /> <br />`
2. If you want show `<xx>`, replace with `&lt;xx&gt;`