Skip to content

Commit

Permalink
docs: Adapt mkdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
SWHL committed Jun 15, 2024
1 parent e0cc44c commit 4ad78e2
Show file tree
Hide file tree
Showing 167 changed files with 395 additions and 12,891 deletions.
1 change: 1 addition & 0 deletions .cache/plugin/git-committers/page-authors.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"cache_date": "2024-06-15", "page_authors": {"docs/index.md": {"last_commit_date": "2024-06-04", "authors": [{"login": "SWHL", "name": "SWHL", "url": "https://github.com/SWHL", "avatar": "https://avatars.githubusercontent.com/u/28639377?v=4"}]}, "docs/business_support.md": {"last_commit_date": "2024-06-04", "authors": [{"login": "SWHL", "name": "SWHL", "url": "https://github.com/SWHL", "avatar": "https://avatars.githubusercontent.com/u/28639377?v=4"}]}, "docs/communicate.md": {"last_commit_date": "2024-06-04", "authors": [{"login": "SWHL", "name": "SWHL", "url": "https://github.com/SWHL", "avatar": "https://avatars.githubusercontent.com/u/28639377?v=4"}]}, "docs/online_demo.md": {"last_commit_date": "2024-06-04", "authors": [{"login": "SWHL", "name": "SWHL", "url": "https://github.com/SWHL", "avatar": "https://avatars.githubusercontent.com/u/28639377?v=4"}]}, "docs/quickstart.md": {"last_commit_date": "2024-06-10", "authors": []}, "docs/sponsor.md": {"last_commit_date": "2024-06-04", "authors": [{"login": "SWHL", "name": "SWHL", "url": "https://github.com/SWHL", "avatar": "https://avatars.githubusercontent.com/u/28639377?v=4"}]}, "docs/blog/index.md": {"last_commit_date": "2024-06-04", "authors": [{"login": "SWHL", "name": "SWHL", "url": "https://github.com/SWHL", "avatar": "https://avatars.githubusercontent.com/u/28639377?v=4"}]}, "docs/blog/posts/faq.md": {"last_commit_date": "2024-06-04", "authors": [{"login": "SWHL", "name": "SWHL", "url": "https://github.com/SWHL", "avatar": "https://avatars.githubusercontent.com/u/28639377?v=4"}]}, "docs/blog/posts/optim_tutorial.md": {"last_commit_date": "2024-06-04", "authors": [{"login": "SWHL", "name": "SWHL", "url": "https://github.com/SWHL", "avatar": "https://avatars.githubusercontent.com/u/28639377?v=4"}]}, "docs/blog/posts/other_programing_lan.md": {"last_commit_date": "2024-06-04", "authors": [{"login": "SWHL", "name": "SWHL", "url": "https://github.com/SWHL", "avatar": "https://avatars.githubusercontent.com/u/28639377?v=4"}]}, "docs/blog/posts/rec_dict_onnx.md": {"last_commit_date": "2024-06-04", "authors": [{"login": "SWHL", "name": "SWHL", "url": "https://github.com/SWHL", "avatar": "https://avatars.githubusercontent.com/u/28639377?v=4"}]}, "docs/blog/posts/about_model/convert_model.md": {"last_commit_date": "2024-06-04", "authors": [{"login": "SWHL", "name": "SWHL", "url": "https://github.com/SWHL", "avatar": "https://avatars.githubusercontent.com/u/28639377?v=4"}]}, "docs/blog/posts/about_model/custom_different_model.md": {"last_commit_date": "2024-06-04", "authors": [{"login": "SWHL", "name": "SWHL", "url": "https://github.com/SWHL", "avatar": "https://avatars.githubusercontent.com/u/28639377?v=4"}]}, "docs/blog/posts/about_model/download_onnx.md": {"last_commit_date": "2024-06-04", "authors": [{"login": "SWHL", "name": "SWHL", "url": "https://github.com/SWHL", "avatar": "https://avatars.githubusercontent.com/u/28639377?v=4"}]}, "docs/blog/posts/about_model/model_summary.md": {"last_commit_date": "2024-06-04", "authors": [{"login": "SWHL", "name": "SWHL", "url": "https://github.com/SWHL", "avatar": "https://avatars.githubusercontent.com/u/28639377?v=4"}]}, "docs/blog/posts/about_model/support_language.md": {"last_commit_date": "2024-06-04", "authors": [{"login": "SWHL", "name": "SWHL", "url": "https://github.com/SWHL", "avatar": "https://avatars.githubusercontent.com/u/28639377?v=4"}]}, "docs/blog/posts/inference_engine/inference_summary.md": {"last_commit_date": "2024-06-04", "authors": [{"login": "SWHL", "name": "SWHL", "url": "https://github.com/SWHL", "avatar": "https://avatars.githubusercontent.com/u/28639377?v=4"}]}, "docs/blog/posts/inference_engine/which_inference.md": {"last_commit_date": "2024-06-04", "authors": [{"login": "SWHL", "name": "SWHL", "url": "https://github.com/SWHL", "avatar": "https://avatars.githubusercontent.com/u/28639377?v=4"}]}, "docs/blog/posts/inference_engine/onnxruntime/infer_optim.md": {"last_commit_date": "2024-06-04", "authors": [{"login": "SWHL", "name": "SWHL", "url": "https://github.com/SWHL", "avatar": "https://avatars.githubusercontent.com/u/28639377?v=4"}]}, "docs/blog/posts/inference_engine/onnxruntime/onnxruntime-gpu.md": {"last_commit_date": "2024-06-04", "authors": [{"login": "SWHL", "name": "SWHL", "url": "https://github.com/SWHL", "avatar": "https://avatars.githubusercontent.com/u/28639377?v=4"}]}, "docs/blog/posts/inference_engine/openvino/infer-gpu.md": {"last_commit_date": "2024-06-04", "authors": [{"login": "SWHL", "name": "SWHL", "url": "https://github.com/SWHL", "avatar": "https://avatars.githubusercontent.com/u/28639377?v=4"}]}, "docs/blog/posts/inference_engine/openvino/infer.md": {"last_commit_date": "2024-06-04", "authors": [{"login": "SWHL", "name": "SWHL", "url": "https://github.com/SWHL", "avatar": "https://avatars.githubusercontent.com/u/28639377?v=4"}]}, "docs/blog/posts/related_projects/derivatives_projects.md": {"last_commit_date": "2024-06-04", "authors": [{"login": "SWHL", "name": "SWHL", "url": "https://github.com/SWHL", "avatar": "https://avatars.githubusercontent.com/u/28639377?v=4"}]}, "docs/blog/posts/related_projects/related_projects.md": {"last_commit_date": "2024-06-04", "authors": [{"login": "SWHL", "name": "SWHL", "url": "https://github.com/SWHL", "avatar": "https://avatars.githubusercontent.com/u/28639377?v=4"}]}, "docs/changelog/rapidocr.md": {"last_commit_date": "2024-06-04", "authors": [{"login": "SWHL", "name": "SWHL", "url": "https://github.com/SWHL", "avatar": "https://avatars.githubusercontent.com/u/28639377?v=4"}]}, "docs/changelog/rapidocr_api.md": {"last_commit_date": "2024-06-04", "authors": [{"login": "SWHL", "name": "SWHL", "url": "https://github.com/SWHL", "avatar": "https://avatars.githubusercontent.com/u/28639377?v=4"}]}, "docs/changelog/rapidocr_paddle.md": {"last_commit_date": "2024-06-04", "authors": [{"login": "SWHL", "name": "SWHL", "url": "https://github.com/SWHL", "avatar": "https://avatars.githubusercontent.com/u/28639377?v=4"}]}, "docs/changelog/rapidocr_vino.md": {"last_commit_date": "2024-06-04", "authors": [{"login": "SWHL", "name": "SWHL", "url": "https://github.com/SWHL", "avatar": "https://avatars.githubusercontent.com/u/28639377?v=4"}]}, "docs/changelog/rapidocr_web.md": {"last_commit_date": "2024-06-04", "authors": [{"login": "SWHL", "name": "SWHL", "url": "https://github.com/SWHL", "avatar": "https://avatars.githubusercontent.com/u/28639377?v=4"}]}, "docs/install_usage/rapidocr_api.md": {"last_commit_date": "2024-06-04", "authors": [{"login": "SWHL", "name": "SWHL", "url": "https://github.com/SWHL", "avatar": "https://avatars.githubusercontent.com/u/28639377?v=4"}]}, "docs/install_usage/rapidocr_paddle.md": {"last_commit_date": "2024-06-04", "authors": [{"login": "SWHL", "name": "SWHL", "url": "https://github.com/SWHL", "avatar": "https://avatars.githubusercontent.com/u/28639377?v=4"}]}, "docs/install_usage/rapidocr/cli.md": {"last_commit_date": "2024-06-04", "authors": [{"login": "SWHL", "name": "SWHL", "url": "https://github.com/SWHL", "avatar": "https://avatars.githubusercontent.com/u/28639377?v=4"}]}, "docs/install_usage/rapidocr/config_yaml.md": {"last_commit_date": "2024-06-09", "authors": []}, "docs/install_usage/rapidocr/install.md": {"last_commit_date": "2024-06-04", "authors": [{"login": "SWHL", "name": "SWHL", "url": "https://github.com/SWHL", "avatar": "https://avatars.githubusercontent.com/u/28639377?v=4"}]}, "docs/install_usage/rapidocr/usage.md": {"last_commit_date": "2024-06-09", "authors": []}, "docs/install_usage/rapidocr_web/desktop_usage.md": {"last_commit_date": "2024-06-04", "authors": [{"login": "SWHL", "name": "SWHL", "url": "https://github.com/SWHL", "avatar": "https://avatars.githubusercontent.com/u/28639377?v=4"}]}, "docs/install_usage/rapidocr_web/nuitka_package.md": {"last_commit_date": "2024-06-04", "authors": [{"login": "SWHL", "name": "SWHL", "url": "https://github.com/SWHL", "avatar": "https://avatars.githubusercontent.com/u/28639377?v=4"}]}, "docs/install_usage/rapidocr_web/ocrweb_multi.md": {"last_commit_date": "2024-06-04", "authors": [{"login": "SWHL", "name": "SWHL", "url": "https://github.com/SWHL", "avatar": "https://avatars.githubusercontent.com/u/28639377?v=4"}]}, "docs/install_usage/rapidocr_web/pyinstaller.md": {"last_commit_date": "2024-06-04", "authors": [{"login": "SWHL", "name": "SWHL", "url": "https://github.com/SWHL", "avatar": "https://avatars.githubusercontent.com/u/28639377?v=4"}]}, "docs/install_usage/rapidocr_web/rapidocr_web.md": {"last_commit_date": "2024-06-04", "authors": [{"login": "SWHL", "name": "SWHL", "url": "https://github.com/SWHL", "avatar": "https://avatars.githubusercontent.com/u/28639377?v=4"}]}, "docs/install_usage/api/RapidOCR.md": {"last_commit_date": "2024-06-09", "authors": []}, "docs/install_usage/api/VisRes.md": {"last_commit_date": "2024-06-09", "authors": []}}}
29 changes: 29 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: ci
on:
push:
branches:
- master
- main
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Configure Git Credentials
run: |
git config user.name github-actions[bot]
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
- uses: actions/setup-python@v5
with:
python-version: 3.x
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- uses: actions/cache@v4
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-material-
- run: pip install mkdocs-material jieba mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2
- run: mkdocs gh-deploy --force
42 changes: 0 additions & 42 deletions .github/workflows/gh-pages.yml

This file was deleted.

Empty file removed .hugo_build.lock
Empty file.
Empty file removed .nojekyll
Empty file.
1 change: 0 additions & 1 deletion CNAME

This file was deleted.

43 changes: 0 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,43 +0,0 @@
#### 说明
- 这是RapidAI-team主站的仓库
- 主题来自:[tella](https://github.com/opera7133/tella)

#### 如何撰写博客
- 打开`content/blog`,直接仿照`llm-summary.md`,复制开头,后续直接写即可。
```text
+++
author = "SWHL"
title = "LLM梳理"
date = "2023-04-15"
description = "梳理已有LLM项目"
tags = ["llm"]
+++
```

#### 修改主题,支持mermaid
- 手动下载`mermaid.min.js`文件到放到`themes/tella/static/js/mermaid.min.js`下。下载地址[mermaid.js](https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js)
-`layouts/partials/head.html`添加以下代码
```html
<script src='{{ "/js/mermaid.min.js" | relURL }}'></script>

<script>
// 自定义mermaid配置
const config = {
startOnLoad:true,
theme: 'forest',
themeVariables: {
lineColor: "#fafafa" // 由于paperMod的代码块背景是黑色的,这里将线条设置为白色
},
flowchart: {
useMaxWidth:false,
htmlLabels:true
}
};
mermaid.initialize(config);
// 需要注意的是,要将初始化代码放到 window.onload 回调函数里面才有用
// 否则会因为在html元素加载前进行初始化,找不到元素而失效
window.onload = () => {
window.mermaid.init(undefined, document.querySelectorAll('.language-mermaid'));
}
</script>
```
5 changes: 0 additions & 5 deletions archetypes/default.md

This file was deleted.

69 changes: 0 additions & 69 deletions config.toml

This file was deleted.

3 changes: 0 additions & 3 deletions content/_index.md

This file was deleted.

25 changes: 0 additions & 25 deletions content/about.md

This file was deleted.

6 changes: 0 additions & 6 deletions content/blog/_index.md

This file was deleted.

Loading

0 comments on commit 4ad78e2

Please sign in to comment.