halo/docs
1
0
Fork 0
mirror of https://github.com/halo-dev/docs.git synced 2026-03-18 01:03:29 +08:00
Code Issues Packages Projects Releases Wiki Activity
115 Commits 3 Branches 0 Tags
f92e5ca38760bf3420f6065edf2ff52a9ad817dc
Go to file
Clone
Open with VS Code Open with VSCodium Open with Intellij IDEA
Download ZIP Download TAR.GZ Download BUNDLE
Ryan Wang f92e5ca387 docs: add basic documentation for theme development (#102) 
添加最基本的主题开发文档，仅编写从创建主题项目到最终预览的部分。

/kind documentation

```release-noe
None
```
2022-11-18 06:30:26 +00:00
.github/workflows
chore: actions add check step (#61)
2022-03-30 20:19:02 +08:00
.husky
chore: use markdownlint and add pre commit hook (#41)
2022-02-14 15:34:33 +08:00
.vscode
chore: use markdownlint and add pre commit hook (#41)
2022-02-14 15:34:33 +08:00
docs
docs: add basic documentation for theme development (#102)
2022-11-18 06:30:26 +00:00
i18n/zh-Hans
refactor: document versioning structure (#99)
2022-10-13 03:58:14 +00:00
src
chore: remove archived documentations (#72)
2022-04-14 07:49:17 +00:00
static
docs: add documentation for local environment runs (#101)
2022-10-14 03:42:17 +00:00
versioned_docs
Change mirror frontend URL from https://dl.halo.run to https://download.halo.run (#108)
2022-11-14 14:06:14 +00:00
versioned_sidebars
refactor: document versioning structure (#99)
2022-10-13 03:58:14 +00:00
.gitignore
chore(deps): upgrade docusaurus to beta.13 (#15)
2021-12-12 16:02:48 +08:00
.markdownlint.json
docs: improve docker compose documentations (#74)
2022-04-16 14:05:57 +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: document versioning structure (#99)
2022-10-13 03:58:14 +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
refactor: document versioning structure (#99)
2022-10-13 03:58:14 +00:00
pnpm-lock.yaml
chore: bump docusaurus to 2.1.0 (#91)
2022-09-28 15:14:16 +00:00
README.md
docs: update readme.md
2021-11-23 20:51:14 +08:00
sidebars.js
docs: add basic documentation for theme development (#102)
2022-11-18 06:30:26 +00:00
versions.json
refactor: document versioning structure (#99)
2022-10-13 03:58:14 +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.

Reference in New Issue View Git Blame Copy Permalink
Description
The open-source repo for docs.halo.run
Readme 218 MiB
Languages
MDX 53.5%
JavaScript 30.5%
TypeScript 8.7%
SCSS 5.7%
CSS 1.5%