halo/docs

mirror of https://github.com/halo-dev/docs.git synced 2025-10-20 01:17:19 +00:00

Go to file

Ryan Wang 97e0b2b526 refactor: documentation structure (#310 )

重构文档结构，将开发者文档与使用文档分开。

<img width="641" alt="image" src="https://github.com/halo-dev/docs/assets/21301288/baed360c-997b-443c-9a8e-cc53e268b8f4">
<img width="766" alt="image" src="https://github.com/halo-dev/docs/assets/21301288/08326aab-d474-4075-bdc9-c628a39ba715">


Note: 此改动不造成死链。

```release-note
None
```

2024-02-05 10:00:13 +00:00

.github/workflows

chore: zip dist files before ssh deploy (#268 )

2023-10-26 11:35:45 +08:00

chore: use markdownlint and add pre commit hook (#41 )

2022-02-14 15:34:33 +08:00

docs: update documentation for Halo 2.4 (#203 )

2023-03-31 03:54:14 +00:00

docs: update documentation for Halo 2.12 (#306 )

2024-02-01 03:11:39 +00:00

docs: update documentation for Halo 2.12 (#306 )

2024-02-01 03:11:39 +00:00

feat: add image zoom feature (#250 )

2023-09-06 08:56:14 +00:00

docs: refactor documentation of plugin development (#291 )

2024-01-30 16:00:18 +08:00

docs: update documentation for Halo 2.12 (#306 )

2024-02-01 03:11:39 +00:00

versioned_sidebars

refactor: documentation structure (#310 )

2024-02-05 10:00:13 +00:00

.gitignore

chore(deps): upgrade docusaurus to beta.13 (#15 )

2021-12-12 16:02:48 +08:00

.markdownlint.json

docs: refine the field descriptions of the theme VO (#133 )

2022-12-08 04:54:10 +00:00

.npmrc

chore: bump docusaurus to beta 16 (#44 )

2022-02-26 12:08:00 +08:00

babel.config.js

first commit

2021-10-05 14:30:42 +08:00

docusaurus.config.js

refactor: documentation structure (#310 )

2024-02-05 10:00:13 +00:00

netlify.toml

chore: add netlify config file (#14 )

2021-12-09 21:28:53 +08:00

OWNERS

chore: create OWNERS (#60 )

2022-03-28 21:59:04 +08:00

package.json

chore: remove 1.x documentation (#303 )

2024-01-02 02:38:12 +00:00

pnpm-lock.yaml

chore: remove 1.x documentation (#303 )

2024-01-02 02:38:12 +00:00

README.md

docs: update readme.md

2021-11-23 20:51:14 +08:00

sidebars.js

refactor: documentation structure (#310 )

2024-02-05 10:00:13 +00:00

versions.json

docs: update documentation for Halo 2.12 (#306 )

2024-02-01 03:11:39 +00:00

versionsArchived.json

refactor: document versioning structure (#99 )

2022-10-13 03:58:14 +00:00

README.md

The open-source repo for docs.halo.run

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ pnpm install

If you don’t have pnpm installed, you can install it with the following command:

npm install -g pnpm

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.