Skip to content

Commit

Permalink
docs: 更新文档
Browse files Browse the repository at this point in the history
  • Loading branch information
lzxb committed Nov 1, 2024
1 parent a5fabcd commit a56d56f
Show file tree
Hide file tree
Showing 26 changed files with 2,737 additions and 127 deletions.
40 changes: 40 additions & 0 deletions deploy.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
#!/bin/bash

# 确保脚本抛出遇到的错误
set -e

rm -rf dist
# 编译代码
npm run build

# 文心一言提供的脚本
src_base="examples"
target_base="dist"

for src_dir in "$src_base"/ssr-*/dist/client "$src_base"/docs/dist/client; do
if [ -d "$src_dir" ]; then
if [ "$src_dir" = "$src_base/docs/dist/client" ]; then
target_dir="$target_base"
else
ssr_part="${src_dir#$src_base/}"
ssr_part="${ssr_part%/dist/client}"
target_dir="$target_base/$ssr_part"
fi
mkdir -p "$target_dir"
cp -r "$src_dir"/* "$target_dir"
echo "Copied $src_dir/* to $target_dir"
fi
done

cd dist
# 如果是发布到自定义域名
# echo 'www.example.com' > CNAME

git init
git add -A
git commit -m 'deploy'

# 如果发布到 https://dp-os.github.io/gez/
git push -f [email protected]:dp-os/gez.git master:docs

cd -
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/package.json → examples/docs/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "rspress-doc-template",
"name": "docs",
"version": "1.0.0",
"private": true,
"scripts": {
Expand Down
5 changes: 3 additions & 2 deletions docs/rspress.config.ts → examples/docs/rspress.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@ import * as path from 'node:path';
import { defineConfig } from 'rspress/config';

export default defineConfig({
root: path.join(__dirname, 'docs'),
globalStyles: path.join(__dirname, 'styles/index.css'),
root: path.join(__dirname, 'src'),
outDir: path.join(__dirname, 'dist/client'),
globalStyles: path.join(__dirname, 'src/styles/index.css'),
title: 'Gez',
description:
'Gez 是一个基于 Rspack 构建的模块链接(Module Link) 解决方案,通过 importmap 将多服务的模块映射到具有强缓存,基于内容哈希的 URL 中。',
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@
一个典型的命令配置。
```json
{
"scripts": {
"dev": "gez dev",
"build": "npm run build && npm run build:dts && npm run release",
"build:ssr": "gez build",
"build:dts": "vue-tsc --declaration --emitDeclarationOnly --noEmit false --outDir dist/server/src",
"release": "gez release",
"preview": "gez preview",
"start": "gez start",
"postinstall": "gez install"
}
"scripts": {
"dev": "gez dev",
"build": "npm run build:ssr && npm run build:dts && npm run release",
"build:ssr": "gez build",
"build:dts": "vue-tsc --declaration --emitDeclarationOnly --noEmit false --outDir dist/server/src",
"release": "gez release",
"preview": "gez preview",
"start": "gez start",
"postinstall": "gez install"
}
}
```

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
13 changes: 9 additions & 4 deletions examples/ssr-html/package.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
{
"name": "ssr-simple",
"name": "ssr-html",
"version": "0.0.15-alpha.89",
"main": "index.js",
"type": "module",
"scripts": {
"dev": "gez dev",
"build": "gez build",
"start": "gez start",
"build": "npm run build:ssr && npm run build:dts && npm run release",
"build:ssr": "gez build",
"build:dts": "tsc --noEmit --outDir dist/server/src",
"release": "gez release",
"preview": "gez preview",
"start": "gez start",
"postinstall": "gez install"
},
"author": "",
Expand All @@ -17,6 +20,8 @@
"@gez/core": "workspace:0.0.15-alpha.89"
},
"devDependencies": {
"@types/node": "22.8.6",
"typescript": "^5.2.2",
"@gez/rspack": "workspace:0.0.15-alpha.89"
}
}
}
4 changes: 3 additions & 1 deletion examples/ssr-html/src/entry.client.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
const time = document.querySelector('time');
setInterval(() => {
time?.setHTMLUnsafe(new Date().toISOString());
if (time) {
time.innerText = new Date().toISOString();
}
}, 1000);
60 changes: 60 additions & 0 deletions examples/ssr-html/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
{
"compilerOptions": {
"isolatedModules": true,
"allowJs": false,
"experimentalDecorators": true,
"resolveJsonModule": true,
"types": [
"@types/node"
],
"target": "ESNext",
"module": "ESNext",
"importHelpers": false,
"declaration": true,
"sourceMap": true,
"strict": true,
"noImplicitAny": false,
"noImplicitReturns": false,
"noFallthroughCasesInSwitch": true,
"noUnusedLocals": false,
"noUnusedParameters": false,
"moduleResolution": "node",
"allowImportingTsExtensions": true,
"esModuleInterop": true,
"skipLibCheck": true,
"allowSyntheticDefaultImports": true,
"forceConsistentCasingInFileNames": true,
"noEmit": true,
"paths": {
"ssr-rspack-vue2/src/*": [
"./src/*"
],
"ssr-rspack-vue2/*": [
"./*"
]
}
},
"include": [
"micro",
"service",
"server",
"test",
"src",
"bin",
"**.cjs",
"**.js",
"**.mjs",
"**.ts",
"private",
"public"
],
"exclude": [
"dist"
],
"vueCompilerOptions": {
"extensions": [
".vue"
],
"target": 2.7
}
}
7 changes: 5 additions & 2 deletions examples/ssr-vue2-host/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,11 @@
"type": "module",
"scripts": {
"dev": "gez dev",
"build": "gez build",
"build:dts": "vue-tsc --declaration --emitDeclarationOnly --noEmit false --outDir types",
"build": "npm run build:ssr && npm run build:dts && npm run release",
"build:ssr": "gez build",
"build:dts": "vue-tsc --declaration --emitDeclarationOnly --noEmit false --outDir dist/server/src",
"release": "gez release",
"preview": "gez preview",
"start": "gez start",
"postinstall": "gez install"
},
Expand Down
10 changes: 6 additions & 4 deletions examples/ssr-vue2-remote/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,13 @@
"type": "module",
"scripts": {
"dev": "gez dev",
"build": "gez build",
"build:release": "gez release",
"build": "npm run build:ssr && npm run build:dts && npm run release",
"build:ssr": "gez build",
"build:dts": "vue-tsc --declaration --emitDeclarationOnly --noEmit false --outDir dist/server/src",
"build:all": "gez build && npm run build:dts && gez release",
"start": "gez start"
"release": "gez release",
"preview": "gez preview",
"start": "gez start",
"postinstall": "gez install"
},
"dependencies": {
"@gez/core": "workspace:^",
Expand Down
10 changes: 7 additions & 3 deletions examples/ssr-vue3/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,13 @@
"type": "module",
"scripts": {
"dev": "gez dev",
"build": "gez build",
"build:dts": "vue-tsc --declaration --emitDeclarationOnly --noEmit false --outDir types",
"start": "gez start"
"build": "npm run build:ssr && npm run build:dts && npm run release",
"build:ssr": "gez build",
"build:dts": "vue-tsc --declaration --emitDeclarationOnly --noEmit false --outDir dist/server/src",
"release": "gez release",
"preview": "gez preview",
"start": "gez start",
"postinstall": "gez install"
},
"dependencies": {
"@gez/core": "workspace:^",
Expand Down
4 changes: 0 additions & 4 deletions logo.svg

This file was deleted.

1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
"lint:css": "lerna run lint:css",
"lint:type": "lerna run lint:type",
"test": "lerna run test",
"build": "lerna run build",
"build:packages": "lerna run build --no-private",
"release": "npm run build:packages && lerna publish --force-publish --exact"
},
Expand Down
Loading

0 comments on commit a56d56f

Please sign in to comment.