Skip to content

Commit beff281

Browse files
horchamhorcham
andauthored
Try to fix link on mindocr web (#650)
* Add Doc * Add Doc * update index.md --------- Co-authored-by: horcham <[email protected]>
1 parent e5bae3b commit beff281

File tree

5 files changed

+12
-15
lines changed

5 files changed

+12
-15
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
1+
<!--start-->
12
<div align="center" markdown>
23

34
# MindOCR
5+
<!--end-->
46

57
[![CI](https://github.com/mindspore-lab/mindocr/actions/workflows/ci.yml/badge.svg)](https://github.com/mindspore-lab/mindocr/actions/workflows/ci.yml)
68
[![license](https://img.shields.io/github/license/mindspore-lab/mindocr.svg)](https://github.com/mindspore-lab/mindocr/blob/main/LICENSE)
79
[![open issues](https://img.shields.io/github/issues/mindspore-lab/mindocr)](https://github.com/mindspore-lab/mindocr/issues)
810
[![PRs](https://img.shields.io/badge/PRs-welcome-pink.svg)](https://github.com/mindspore-lab/mindocr/pulls)
911
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
1012

11-
13+
<!--start-->
1214
English | [中文](README_CN.md)
1315

1416
[📝Introduction](#introduction) |
@@ -386,3 +388,4 @@ If you find this project useful in your research, please consider citing:
386388
year={2023}
387389
}
388390
```
391+
<!--end-->

README_CN.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
1+
<!--start-->
12
<div align="center" markdown>
23

34
# MindOCR
5+
<!--end-->
46

57
[![CI](https://github.com/mindspore-lab/mindocr/actions/workflows/ci.yml/badge.svg)](https://github.com/mindspore-lab/mindocr/actions/workflows/ci.yml)
68
[![license](https://img.shields.io/github/license/mindspore-lab/mindocr.svg)](https://github.com/mindspore-lab/mindocr/blob/main/LICENSE)
79
[![open issues](https://img.shields.io/github/issues/mindspore-lab/mindocr)](https://github.com/mindspore-lab/mindocr/issues)
810
[![PRs](https://img.shields.io/badge/PRs-welcome-pink.svg)](https://github.com/mindspore-lab/mindocr/pulls)
911
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
1012

11-
13+
<!--start-->
1214
[English](README.md) | 中文
1315

1416
[📝简介](#简介) |
@@ -384,3 +386,4 @@ MindOCR提供了[数据格式转换工具](tools/dataset_converters) ,以支
384386
year={2023}
385387
}
386388
```
389+
<!--end-->

docs/cn/index.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,2 @@
1-
---
2-
hide:
3-
- navigation
4-
- toc
5-
---
6-
71

82
{% include-markdown "../../README_CN.md" %}

docs/en/index.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,2 @@
1-
---
2-
hide:
3-
- navigation
4-
- toc
5-
---
6-
71

82
{% include-markdown "../../README.md" %}

mkdocs.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,10 @@ markdown_extensions:
118118

119119
plugins:
120120
- search
121-
- include-markdown
121+
- include-markdown:
122+
rewrite-relative-urls: false
123+
start: <!--start-->
124+
end: <!--end-->
122125
- mkdocstrings:
123126
default_handler: python
124127
handlers:

0 commit comments

Comments
 (0)