Skip to content

Commit a07b0a8

Browse files
📝 更新文档,优化配置与内容结构
- 在`docusaurus.config.js`中添加注释,说明样式表的必要性以避免样式异常。 - 更新`README.md`,调整内容顺序,增强对Markdown功能的描述,新增Docker构建与运行指南,提升文档的实用性与可读性。
1 parent fabae84 commit a07b0a8

File tree

3 files changed

+56
-2
lines changed

3 files changed

+56
-2
lines changed

Dockerfile

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# 构建阶段
2+
FROM node:20 AS build
3+
WORKDIR /app
4+
COPY package*.json ./
5+
RUN npm install
6+
COPY . .
7+
RUN npm run build
8+
9+
# 生产阶段
10+
FROM nginx:alpine
11+
COPY --from=build /app/build /usr/share/nginx/html
12+
13+
EXPOSE 80
14+
CMD ["nginx", "-g", "daemon off;"]

README.md

Lines changed: 41 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@
1414

1515
- 配置生成式 AI 文章总结,完全的Github部署。[访问 博客文本摘要](https://jiangmiemie.com/blog/2024/1/31/)
1616

17-
- 集成 React Photo Album,布局优雅,点击照片可放大并展示照片描述、拍摄地、照片尺寸等信息[访问 照片墙](https://jiangmiemie.com/gallery/)
17+
- 内置多种字体高亮、集成 mermaid 、markmap、 KaTeX ,让数学公式和流程图的编辑更加便捷[访问 markdown](https://jiangmiemie.com/docs/编程外的基础/Markdown/)
1818

19-
- 集成 mermaid 、markmap、 KaTeX ,让数学公式和流程图的编辑更加便捷[访问 markdown](https://jiangmiemie.com/docs/编程外的基础/Markdown/)
19+
- 集成 React Photo Album,布局优雅,点击照片可放大并展示照片描述、拍摄地、照片尺寸等信息[访问 照片墙](https://jiangmiemie.com/gallery/)
2020

2121
- 集成 giscus,使用 GitHub 账号评论,还能一键分享至 twitter。[访问 博客页](https://jiangmiemie.com/blog/)
2222

@@ -80,6 +80,45 @@
8080
- `npm audit`:检查漏洞
8181
- `npm install`:下载所需依赖包
8282
- `npm run start`:启动站点
83+
- `npm run build`: 打包为静态站点
84+
85+
## Docker参考
86+
87+
### 构建 Docker
88+
89+
在项目目录下执行以下命令,将 Dockerfile 中定义的内容构建为版本号为 `0.0.1` 的镜像:
90+
91+
```bash
92+
docker build -t jiangmiemie:0.0.1 .
93+
```
94+
95+
说明:该命令会读取当前目录下的 Dockerfile 并构建出镜像 `jiangmiemie:0.0.1`
96+
97+
### 保存镜像为 tar 文件
98+
99+
使用 `docker save` 命令将刚构建好的镜像导出成 tar 文件:
100+
101+
```bash
102+
docker save -o jiangmiemie_0.0.1.tar jiangmiemie:0.0.1
103+
```
104+
105+
说明:生成的 `jiangmiemie_0.0.1.tar` 文件包含了该镜像的所有数据,方便后续的传输。
106+
107+
Ubuntu使用 `docker load` 加载镜像:
108+
109+
```bash
110+
docker load -i jiangmiemie_0.0.1.tar
111+
```
112+
113+
### 运行 Docker 容器
114+
115+
加载完成后,使用下面的命令运行容器,并将服务器的端口 8080 映射至容器的 8080 端口:
116+
117+
```bash
118+
docker run -d -p 8080:80 --name jiangmiemie jiangmiemie:0.0.1
119+
```
120+
121+
说明:该命令会以后台模式运行镜像 `jiangmiemie:0.0.1`,容器名称为 `jiangmiemie`,使得你可以通过 Ubuntu 服务器上的 `8080` 端口访问该应用。
83122

84123
## 许可证信息
85124

docusaurus.config.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,7 @@ module.exports = {
142142
markdown: {
143143
mermaid: true,
144144
},
145+
// 如不添加可能会样式异常,展示2次
145146
stylesheets: [
146147
{
147148
href: "/katex/katex.min.css",

0 commit comments

Comments
 (0)