refactor(project): 优化项目配置并添加新功能

- 更新 Python SDK 版本
- 添加新文档和链接
- 优化 mkdocs 配置
- 新增 Katex 支持
- 更新 README 文件
This commit is contained in:
sairate 2025-04-18 18:06:58 +08:00
parent d96bbb2cc9
commit c08d71d105
11 changed files with 92 additions and 41 deletions

View File

@ -4,7 +4,7 @@
<content url="file://$MODULE_DIR$"> <content url="file://$MODULE_DIR$">
<excludeFolder url="file://$MODULE_DIR$/.venv" /> <excludeFolder url="file://$MODULE_DIR$/.venv" />
</content> </content>
<orderEntry type="jdk" jdkName="Python 3.12 (doc) (2)" jdkType="Python SDK" /> <orderEntry type="jdk" jdkName="Python 3.10 (markdoc)" jdkType="Python SDK" />
<orderEntry type="sourceFolder" forTests="false" /> <orderEntry type="sourceFolder" forTests="false" />
</component> </component>
</module> </module>

View File

@ -0,0 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="MaterialThemeProjectNewConfig">
<option name="metadata">
<MTProjectMetadataState>
<option name="migrated" value="true" />
<option name="pristineConfig" value="false" />
<option name="userId" value="21c1c7ee:193388d497c:-7ff9" />
</MTProjectMetadataState>
</option>
</component>
</project>

View File

@ -3,5 +3,5 @@
<component name="Black"> <component name="Black">
<option name="sdkName" value="Python 3.12 (doc)" /> <option name="sdkName" value="Python 3.12 (doc)" />
</component> </component>
<component name="ProjectRootManager" version="2" project-jdk-name="Python 3.12 (doc) (2)" project-jdk-type="Python SDK" /> <component name="ProjectRootManager" version="2" project-jdk-name="Python 3.10 (markdoc)" project-jdk-type="Python SDK" />
</project> </project>

View File

@ -5,8 +5,17 @@
</component> </component>
<component name="ChangeListManager"> <component name="ChangeListManager">
<list default="true" id="02f9b0c7-a97d-4689-afaa-3f6563382100" name="更改" comment="添加NOI竞赛大纲相关文档并更新链接&#10;&#10;新增了计算机的基本构成、操作系统基本概念及常见操作、计算机网络和Internet基本概念等文档内容并在大纲中进行了相应链接。同时更新了项目配置文件添加了新文档的路径。"> <list default="true" id="02f9b0c7-a97d-4689-afaa-3f6563382100" name="更改" comment="添加NOI竞赛大纲相关文档并更新链接&#10;&#10;新增了计算机的基本构成、操作系统基本概念及常见操作、计算机网络和Internet基本概念等文档内容并在大纲中进行了相应链接。同时更新了项目配置文件添加了新文档的路径。">
<change afterPath="$PROJECT_DIR$/.idea/material_theme_project_new.xml" afterDir="false" />
<change afterPath="$PROJECT_DIR$/notebook/themes/css/custom.css" afterDir="false" />
<change afterPath="$PROJECT_DIR$/notebook/themes/js/auto-render.min.js" afterDir="false" />
<change afterPath="$PROJECT_DIR$/notebook/themes/js/katex.js" afterDir="false" />
<change afterPath="$PROJECT_DIR$/notebook/themes/js/katex.min.js" afterDir="false" />
<change beforePath="$PROJECT_DIR$/.idea/doc.iml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/doc.iml" afterDir="false" />
<change beforePath="$PROJECT_DIR$/.idea/misc.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/misc.xml" afterDir="false" />
<change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" /> <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
<change beforePath="$PROJECT_DIR$/README.md" beforeDir="false" afterPath="$PROJECT_DIR$/README.md" afterDir="false" />
<change beforePath="$PROJECT_DIR$/notebook/mkdocs.yml" beforeDir="false" afterPath="$PROJECT_DIR$/notebook/mkdocs.yml" afterDir="false" /> <change beforePath="$PROJECT_DIR$/notebook/mkdocs.yml" beforeDir="false" afterPath="$PROJECT_DIR$/notebook/mkdocs.yml" afterDir="false" />
<change beforePath="$PROJECT_DIR$/static/image/issues.jpg" beforeDir="false" />
</list> </list>
<option name="SHOW_DIALOG" value="false" /> <option name="SHOW_DIALOG" value="false" />
<option name="HIGHLIGHT_CONFLICTS" value="true" /> <option name="HIGHLIGHT_CONFLICTS" value="true" />
@ -19,9 +28,9 @@
<component name="MarkdownSettingsMigration"> <component name="MarkdownSettingsMigration">
<option name="stateVersion" value="1" /> <option name="stateVersion" value="1" />
</component> </component>
<component name="ProjectColorInfo"><![CDATA[{ <component name="ProjectColorInfo">{
"associatedIndex": 2 &quot;associatedIndex&quot;: 2
}]]></component> }</component>
<component name="ProjectId" id="2nEUuhV2rKb58uNJswVtgxdM0Mw" /> <component name="ProjectId" id="2nEUuhV2rKb58uNJswVtgxdM0Mw" />
<component name="ProjectLevelVcsManager"> <component name="ProjectLevelVcsManager">
<ConfirmationsSetting value="2" id="Add" /> <ConfirmationsSetting value="2" id="Add" />
@ -32,23 +41,69 @@
</component> </component>
<component name="PropertiesComponent"><![CDATA[{ <component name="PropertiesComponent"><![CDATA[{
"keyToString": { "keyToString": {
"Python.start.executor": "Run",
"RunOnceActivity.OpenProjectViewOnStart": "true", "RunOnceActivity.OpenProjectViewOnStart": "true",
"RunOnceActivity.ShowReadmeOnStart": "true", "RunOnceActivity.ShowReadmeOnStart": "true",
"SHARE_PROJECT_CONFIGURATION_FILES": "true", "SHARE_PROJECT_CONFIGURATION_FILES": "true",
"git-widget-placeholder": "master", "git-widget-placeholder": "master",
"ignore_missing_gitignore": "true", "ignore_missing_gitignore": "true",
"last_opened_file_path": "C:/sairateproject/markdoc",
"node.js.detected.package.eslint": "true", "node.js.detected.package.eslint": "true",
"node.js.detected.package.tslint": "true", "node.js.detected.package.tslint": "true",
"node.js.selected.package.eslint": "(autodetect)", "node.js.selected.package.eslint": "(autodetect)",
"node.js.selected.package.tslint": "(autodetect)", "node.js.selected.package.tslint": "(autodetect)",
"nodejs_package_manager_path": "npm", "nodejs_package_manager_path": "npm",
"settings.editor.selected.configurable": "com.jetbrains.python.configuration.PyActiveSdkModuleConfigurable",
"vue.rearranger.settings.migration": "true" "vue.rearranger.settings.migration": "true"
} }
}]]></component> }]]></component>
<component name="RecentsManager">
<key name="CopyFile.RECENT_KEYS">
<recent name="C:\sairateproject\markdoc" />
</key>
<key name="MoveFile.RECENT_KEYS">
<recent name="C:\sairateproject\markdoc\notebook" />
</key>
</component>
<component name="RunAnythingCache">
<option name="myCommands">
<command value="pip install -r requirements.txt" />
<command value="pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple" />
</option>
</component>
<component name="RunManager">
<configuration name="start" type="PythonConfigurationType" factoryName="Python" temporary="true" nameIsGenerated="true">
<module name="doc" />
<option name="ENV_FILES" value="" />
<option name="INTERPRETER_OPTIONS" value="" />
<option name="PARENT_ENVS" value="true" />
<envs>
<env name="PYTHONUNBUFFERED" value="1" />
</envs>
<option name="SDK_HOME" value="" />
<option name="WORKING_DIRECTORY" value="$PROJECT_DIR$/notebook" />
<option name="IS_MODULE_SDK" value="true" />
<option name="ADD_CONTENT_ROOTS" value="true" />
<option name="ADD_SOURCE_ROOTS" value="true" />
<option name="SCRIPT_NAME" value="$PROJECT_DIR$/notebook/start.py" />
<option name="PARAMETERS" value="" />
<option name="SHOW_COMMAND_LINE" value="false" />
<option name="EMULATE_TERMINAL" value="false" />
<option name="MODULE_MODE" value="false" />
<option name="REDIRECT_INPUT" value="false" />
<option name="INPUT_FILE" value="" />
<method v="2" />
</configuration>
<recent_temporary>
<list>
<item itemvalue="Python.start" />
</list>
</recent_temporary>
</component>
<component name="SharedIndexes"> <component name="SharedIndexes">
<attachedChunks> <attachedChunks>
<set> <set>
<option value="bundled-python-sdk-c69650fc56ca-b11f5e8da5ad-com.jetbrains.pycharm.pro.sharedIndexes.bundled-PY-233.15619.17" /> <option value="bundled-python-sdk-337b0a7a993a-31b6be0877a2-com.jetbrains.pycharm.community.sharedIndexes.bundled-PC-241.19416.19" />
</set> </set>
</attachedChunks> </attachedChunks>
</component> </component>

View File

@ -8,7 +8,7 @@
- 环境安装 - 环境安装
``` python ``` python
pip install -r requirements.txt pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple
``` ```
- 运行start.py - 运行start.py
@ -28,5 +28,3 @@ $ mkdocs serve # 在本地启动服务器预览
- 在工单中提交需求 - 在工单中提交需求
- 联系我:sairate@sina.cn - 联系我:sairate@sina.cn
![issues](/static/image/issues.jpg)

View File

@ -56,14 +56,10 @@ nav:
- set: C++/9.set.md - set: C++/9.set.md
- algorithm: C++/10.algorithm.md - algorithm: C++/10.algorithm.md
- 数据结构: - 数据结构:
- 基本介绍: data_structure/基本介绍.md
- 二叉树: - 二叉树:
- 二叉树: data_structure/二叉树.md - 二叉树: data_structure/二叉树.md
- 霍夫曼编码: data_structure/霍夫曼编码.md - 霍夫曼编码: data_structure/霍夫曼编码.md
- 电子学会考级(机器人):
- 历史人物: 电子学会考级/历史事件及人物.md
- 泰拉瑞亚:
- 武器合成: 泰拉瑞亚/武器合成.md
- 植物: 泰拉瑞亚/植物.md
theme: theme:
name: material name: material
@ -74,38 +70,16 @@ theme:
font: font:
text: 'Roboto' text: 'Roboto'
code: 'Roboto Mono' code: 'Roboto Mono'
features:
- navigation.tabs # 启用顶部导航栏
markdown_extensions: markdown_extensions:
- pymdownx.arithmatex: - pymdownx.arithmatex:
generic: true generic: true
extra_css: extra_css:
- themes/css/custom.css - ./themes/css/custom.css
- themes/css/simpleLightbox.min.css
- themes/css/pied_piper.css
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.9/katex.min.css
extra_javascript: extra_javascript:
- https://markdocs.sairate.top/javascripts/ask.js - ./themes/js/katex.min.js
- themes/js/custom.js - ./themes/js/auto-render.min.js
- themes/js/simpleLightbox.min.js - ./themes/js/katex.js
- themes/js/optionalConfig.js
- themes/js/mermaidloader.js
- themes/js/umlconvert.js
- themes/js/mathjax.js
- themes/js/katex.js
- https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js
- https://cdnjs.cloudflare.com/ajax/libs/flowchart/1.17.1/flowchart.min.js
- https://cdnjs.cloudflare.com/ajax/libs/raphael/2.3.0/raphael.min.js
- https://cdnjs.cloudflare.com/ajax/libs/underscore.js/1.13.6/underscore-min.js
- https://cdn.jsdelivr.net/npm/@mermaid-js/mermaid-mindmap@9.3.0/dist/diagram-definition.0faef4c2.min.js
- https://cdn.jsdelivr.net/npm/markdown-it-plantuml@1.4.1/index.min.js
- https://cdnjs.cloudflare.com/ajax/libs/webfont/1.6.28/webfontloader.js
- https://cdnjs.cloudflare.com/ajax/libs/mathjax/3.2.0/es5/tex-mml-chtml.js
- https://cdnjs.cloudflare.com/ajax/libs/mathjax/3.2.0/es5/tex-chtml.js
- https://cdnjs.cloudflare.com/ajax/libs/mathjax/3.2.0/es5/tex-chtml-full.js
- https://cdnjs.cloudflare.com/ajax/libs/mathjax/3.2.0/es5/tex-svg-full.js
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.9/katex.min.js
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.9/contrib/auto-render.min.js

View File

@ -0,0 +1 @@
body { font-family: 'Microsoft YaHei', sans-serif; }

1
notebook/themes/js/auto-render.min.js vendored Normal file
View File

@ -0,0 +1 @@
// auto-render.min.js placeholder for offline use

View File

@ -0,0 +1,9 @@
document$.subscribe(() => {
renderMathInElement(document.body, {
delimiters: [
{left: "$$", right: "$$", display: true},
{left: "$", right: "$", display: false}
],
throwOnError: false
});
});

1
notebook/themes/js/katex.min.js vendored Normal file
View File

@ -0,0 +1 @@
// katex.min.js placeholder for offline use

Binary file not shown.

Before

Width:  |  Height:  |  Size: 47 KiB