# BabylonDocCN

**Repository Path**: mzfly/babylon-doc-cn

## Basic Information

- **Project Name**: BabylonDocCN
- **Description**: Babylonjs文档网站汉化。
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-05-12
- **Last Updated**: 2023-05-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Babylon.js documentation website 文档网站

The page is written using Next.js (Server-side react framework).

## 汉化说明

- 汉化导航目录文件：configuration/structure.json
- 汉化文档内容目录：content/
- 官方 Github 地址：https://github.com/BabylonJS/Documentation
- 其它无修改

## Requirements 要求

- Node 12 and up
- yarn

## Getting Started 准备开始

Install dependencies 安装依赖

```bash
yarn install
```

Run the development server 运行开发服务器:

```bash
yarn dev
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.用浏览器打开[http://localhost:3000](http://localhost:3000)查看结果。

You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.当您编辑文件时，页面会自动更新。

## Custom markdown components

Markdowns can now be augmented with special components. For example, adding:

```html
<Playground id="#Y642I8" title="Tinted Shadows Example" description="A Playground example of tinted shadows." />
```

will add a playground to the examples pane, allow to show its preview, add a styled link and add it to the search index for the playground. This will also generate images for this playground's preview when needed. Please make sure to commit those images.

Documentation for all markdown components is coming soon.

[![Powered by vercel](public/powered-by-vercel.svg?raw=true)](https://vercel.com/?utm_source=babylonjs&utm_campaign=oss)