An open API service indexing awesome lists of open source software.

https://github.com/typecho/docs

Documentation for Typecho
https://github.com/typecho/docs

Last synced: 9 months ago
JSON representation

Documentation for Typecho

Awesome Lists containing this project

README

          

# Website

This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.

### Installation

```
$ pnpm install
```

### Local Development

```
$ pnpm start
```

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

### Build

```
$ pnpm build
```

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

### Deployment

Using SSH:

```
$ USE_SSH=true pnpm deploy
```

Not using SSH:

```
$ GIT_USER= pnpm deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

### i18n

This website is available in multiple languages. The default language is Simplified Chinese. To create a new language version, run:

```
$ pnpm write-translations --locale
```