Skip to content

Commit 016edaf

Browse files
jiangyangcreatejiangyangcreate
committed
🎉 基于MDX的博客1.0.0版本
0 parents  commit 016edaf

File tree

238 files changed

+44346
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

238 files changed

+44346
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
- Code/Link to Repo:
16+
17+
**Expected behavior**
18+
A clear and concise description of what you expected to happen.
19+
20+
**Screenshots**
21+
If applicable, add screenshots to help explain your problem.
22+
23+
**Additional context**
24+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/bug_report_zh.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: BUG报告
3+
about: 创建一个报告帮助我改进这个项目
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**描述这个BUG**
11+
尽可能简单的描述你遇到的问题
12+
13+
**复制**
14+
再现行为的步骤：
15+
- 代码复现链接：
16+
17+
**预期行为**
18+
对你期望发生的事情的清晰简洁的描述。
19+
20+
21+
**屏幕截图**
22+
如果适用，请添加屏幕截图以帮助解释您的问题。
23+
24+
25+
**附加上下文**
26+
在此处添加有关该问题的任何其他上下文。

‎.github/workflows/updata.yml

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Build HTML
2+
on: push
3+
jobs:
4+
build-and-deploy:
5+
runs-on: ubuntu-latest
6+
permissions:
7+
contents: write
8+
steps:
9+
- uses: actions/checkout@v3
10+
- uses: actions/setup-node@v3
11+
with:
12+
node-version: 18
13+
- run: |
14+
npm install
15+
npm run build
16+
- uses: peaceiris/actions-gh-pages@v3
17+
if: github.ref == 'refs/heads/main'
18+
with:
19+
github_token: ${{ secrets.GITHUB_TOKEN }}
20+
publish_dir: ./build

‎.gitignore

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Dependencies
2+
**/node_modules
3+
4+
# Production
5+
**/build
6+
7+
# Generated files
8+
**.docusaurus
9+
**.cache-loader
10+
11+
*table.py
12+
13+
# Misc
14+
.DS_Store
15+
.env.local
16+
.env.development.local
17+
.env.test.local
18+
.env.production.local
19+
20+
npm-debug.log*
21+
yarn-debug.log*
22+
yarn-error.log*
23+
24+
# draft
25+
draft

‎LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md

+89
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
## 项目概览
2+
3+
欢迎来到这个基于[Docusaurus 3.0](https://docusaurus.io/)最新版本构建的定制站点。
4+
5+
我从[Docusaurus Site Showcase](https://docusaurus.io/showcase)中汲取了许多灵感，但我更倾向于简洁且精美的设计，以确保代码能够便于维护。
6+
7+
**设计理念：美丽优于丑陋，清晰优于模糊。简洁优于复杂，复杂优于繁琐。**
8+
9+
遵循这一理念，我打造了这个精巧而引人注目的个人博客站点。
10+
11+
> 网站性能分析报告：[点此测试](https://pagespeed.web.dev/)
12+
13+
## 核心特性
14+
15+
- 集成 React Photo Album，布局优雅，点击照片可放大并展示照片描述、拍摄地、照片尺寸等信息。[直达照片墙](https://jiangmiemie.com/gallery/)
16+
17+
- 集成 infinum，轻松创建个人案例页，优雅展示个人作品。[立即查看](https://jiangmiemie.com/case/)
18+
19+
- 博客评论与分享，使用 GitHub 账号在博客页下方评论，一键分享至 twitte。[访问博客页体验](https://jiangmiemie.com/blog/)
20+
21+
- 集成 mermaid 与 KaTeX ，让数学公式和流程图的编辑更加便捷。[访问 markdown 演示](https://jiangmiemie.com/docs/编程外的基础/Markdown备忘录/)
22+
23+
- RSS 订阅，支持博客的 RSS 订阅。访问[RSS](https://jiangmiemie.com/blog/rss.xml)即可订阅。
24+
25+
<details>
26+
<summary>点击以查看更多信息</summary>
27+
28+
- 支持生成静态站点，托管至 GitHub Page。[查看 workflows](.github\workflows\updata.yml)
29+
30+
- Algolia 全局搜索，支持站内搜索，帮助你快速找到所需内容，如需配置可在`docusaurus.config.js`中搜索`Algolia`。
31+
32+
- Google Analytics，可查看网站访问情况，如需配置可在`docusaurus.config.js`中搜索`gtag`。
33+
34+
- 公告栏 (announcementBar)，允许在设置一个公告，如需配置可在`docusaurus.config.js`中搜索`announcementBar`。
35+
36+
- 自动明暗模式切换，评论组件、画布、相册都实现了明暗优化。如允许用户主动切换，可在`docusaurus.config.js`中搜索`明暗切换按钮`。
37+
38+
- PWA (Progressive Web App)，让使用网页像使用原生应用一样，可在`docusaurus.config.js`中搜索`pwa`。
39+
40+
- ~~i18n，基于 Crowdin 插件自动翻译~~（但会使构建包体积倍数增长，影响 github-page 部署 ）。
41+
</details>
42+
43+
### 结构目录
44+
45+
```
46+
├──.github
47+
│ └── workflows # GitHub Actions自动部署
48+
├── docusaurus.config.js # 站点配置
49+
├── package.json # 依赖包
50+
├── LICENSE # 许可证
51+
├── README.md # 项目说明
52+
├── .gitignore
53+
├── babel.config.js
54+
├── sidebars.js
55+
├── blog
56+
│ ├── xxxx.md # 博客文件
57+
│ └── authors.yml # 博客作者
58+
├── docs
59+
│ ├── ai # 算法文档
60+
│ ├── read # 书架文档
61+
│ ├── docs # 开发文档
62+
│ └── draft # 草稿
63+
├── src
64+
│ ├── mdxcustom # 自定义MDX组件
65+
│ ├── theme # 自定义主题
66+
│ └── pages # 自定义页面
67+
│ ├──case.js # 案例页
68+
│ ├──gallery.js # 相册页
69+
│ └──index.mdx # 首页
70+
└── static
71+
├── img # 公用图片
72+
├── katex # Latext 公式插件所需资源
73+
├── docs # 与文档相关静态资源
74+
└── pages
75+
├── case # 与案例页相关的静态资源
76+
└── gallery # 与相册页相关的静态资源
77+
```
78+
79+
## 快速启动
80+
81+
以下命令可快速启动和重现项目：
82+
83+
- `npm update`：更新插件
84+
- `npm install`：下载所需依赖包
85+
- `npm run start`：启动站点
86+
87+
## 许可证信息
88+
89+
本项目采用[Apache License 2.0](LICENSE)许可证。

‎babel.config.js

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
3+
};

0 commit comments

Comments
 (0)