https://github.com/bytedance/rspress-website-template

The website template which is based on rspress.
https://github.com/bytedance/rspress-website-template

rspress website-template

Last synced: 1 day ago
JSON representation

The website template which is based on rspress.

• Host: GitHub
• URL: https://github.com/bytedance/rspress-website-template
• Owner: bytedance
• License: apache-2.0
• Created: 2024-01-30T06:00:00.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-04-17T07:21:18.000Z (8 months ago)
• Last Synced: 2024-12-25T20:42:09.219Z (1 day ago)
• Topics: rspress, website-template
• Language: TypeScript
• Homepage: https://bytedance.github.io/rspress-website-template/
• Size: 130 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Rspress website template

This template is a show case of the [Rspress](https://rspress.dev/) which supports the [internationalization](https://rspress.dev/guide/default-theme/i18n.html) with some common documents of the open source project website.

## How to Start the website

```bash

npm install # Install NPM dependencies

npm run dev  # Start local server

npm run build # Build the production bundle, using the doc_build as the default output directory

npm run preview # Start the local preview service

```

## General Folder Structure

```txt

rspress-template

├── docs/ # Latest English docs, use kebab-case

│   ├── en  # the English version of the documents

│   │   ├── _meta.json

│   │   ├── community

│   │   │   └── index.md

│   │   ├── downloads.md

│   │   ├── guide

│   │   │   ├── _meta.json

│   │   │   ├── developer

│   │   │   │   ├── build.md

│   │   │   │   ├── contribution.md

│   │   │   │   └── release.md

│   │   │   ├── start

│   │   │   │   └── quick.md

│   │   └── index.md

│   ├── public  # the common images file share within the document

│   │   ├── rspress-dark-logo.png

│   │   ├── rspress-icon.png

│   │   └── rspress-light-logo.png

│   └── zh # the Chinese version of the documents

│       ├── _meta.json

│       ├── community

│       │   └── index.md

│       ├── downloads.md

│       ├── guide

│       │   ├── _meta.json

│       │   ├── developer

│       │   │   ├── build.md

│       │   │   ├── contribution.md

│       │   │   └── release.md

│       │   ├── start

│       │   │   └── quick.md

│       └── index.md

├── i18n.json   # the internationalization file

...

```