Skip to content

Commit

Permalink
typo: fix readme and bfe_modules's md files
Browse files Browse the repository at this point in the history
Signed-off-by: kwanhur <huang_hua2012@163.com>
  • Loading branch information
kwanhur committed Jan 30, 2022
1 parent 7a9c6fc commit d8f9d66
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 26 deletions.
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -129,11 +129,11 @@ precommit:

# make mdlint
mdlint:
$(MDLINT) $(WORKROOT)
$(MDLINT) --ignore $(WORKROOT)/**/testdata/**/*.md $(WORKROOT)

# make mdlint-fix
mdlint-fix:
$(MDLINT) --fix $(WORKROOT)
$(MDLINT) --fix --ignore $(WORKROOT)/**/testdata/**/*.md $(WORKROOT)

# make check
check:
Expand Down
2 changes: 1 addition & 1 deletion README-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ BFE (Beyond Front End) 是百度开源的现代化、企业级的七层负载均

BFE 是 [云原生计算基金会 (Cloud Native Computing Foundation, CNCF)](https://cncf.io/) 的一个沙箱项目

![](./docs/images/cncf-logo.png)
![cncf-logo](./docs/images/cncf-logo.png)

## 简介

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ BFE (Beyond Front End) is a modern layer 7 load balancer from baidu.

BFE is a [Cloud Native Computing Foundation](https://cncf.io/) (CNCF) sandbox project.

![](./docs/images/cncf-logo.png)
![cncf-logo](./docs/images/cncf-logo.png)

## Introduction

Expand Down
2 changes: 1 addition & 1 deletion bfe_modules/mod_markdown/testdata/testcase0.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# hello world
# hello world
26 changes: 6 additions & 20 deletions bfe_modules/mod_markdown/testdata/testcase1.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,17 @@ You will like those projects!

---

# h1 Heading
# h1 Heading

## h2 Heading

### h3 Heading

#### h4 Heading

##### h5 Heading
###### h6 Heading

###### h6 Heading

## Horizontal Rules

Expand All @@ -26,7 +30,6 @@ ___

***


## Typographic replacements

Enable typographer option to see result.
Expand All @@ -39,7 +42,6 @@ test.. test... test..... test?..... test!....

"Smartypants, double quotes" and 'single quotes'


## Emphasis

**This is bold text**
Expand All @@ -52,15 +54,12 @@ _This is italic text_

~~Strikethrough~~


## Blockquotes


> Blockquotes can also be nested...
>> ...by using additional greater-than signs right next to each other...
> > > ...or with spaces between arrows.

## Lists

Unordered
Expand All @@ -79,7 +78,6 @@ Ordered
2. Consectetur adipiscing elit
3. Integer molestie lorem at massa


1. You can use sequential numbers...
1. ...or keep all the numbers as `1.`

Expand All @@ -88,7 +86,6 @@ Start numbering with offset:
57. foo
1. bar


## Code

Inline `code`
Expand All @@ -100,7 +97,6 @@ Indented code
line 2 of code
line 3 of code


Block code "fences"

```
Expand Down Expand Up @@ -133,7 +129,6 @@ Right aligned columns
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext | extension to be used for dest files. |


## Links

[link text](http://dev.nodeca.com)
Expand All @@ -142,7 +137,6 @@ Right aligned columns

Autoconverted link https://github.com/nodeca/pica (enable linkify to see)


## Images

![Minion](https://octodex.github.com/images/minion.png)
Expand All @@ -156,13 +150,11 @@ With a reference later in the document defining the URL location:

[id]: https://octodex.github.com/images/dojocat.jpg "The Dojocat"


## Plugins

The killer feature of `markdown-it` is very effective support of
[syntax plugins](https://www.npmjs.org/browse/keyword/markdown-it-plugin).


### [Emojies](https://github.com/markdown-it/markdown-it-emoji)

> Classic markup: :wink: :crush: :cry: :tear: :laughing: :yum:
Expand All @@ -171,23 +163,19 @@ The killer feature of `markdown-it` is very effective support of
see [how to change output](https://github.com/markdown-it/markdown-it-emoji#change-output) with twemoji.


### [Subscript](https://github.com/markdown-it/markdown-it-sub) / [Superscript](https://github.com/markdown-it/markdown-it-sup)

- 19^th^
- H~2~O


### [\<ins>](https://github.com/markdown-it/markdown-it-ins)

++Inserted text++


### [\<mark>](https://github.com/markdown-it/markdown-it-mark)

==Marked text==


### [Footnotes](https://github.com/markdown-it/markdown-it-footnote)

Footnote 1 link[^first].
Expand All @@ -204,7 +192,6 @@ Duplicated footnote reference[^second].

[^second]: Footnote text.


### [Definition lists](https://github.com/markdown-it/markdown-it-deflist)

Term 1
Expand All @@ -229,7 +216,6 @@ Term 2
~ Definition 2a
~ Definition 2b


### [Abbreviations](https://github.com/markdown-it/markdown-it-abbr)

This is HTML abbreviation example.
Expand Down
5 changes: 4 additions & 1 deletion bfe_modules/mod_trace/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
# mod_trace

## Introduction

mod_trace is a BFE plugin for OpenTracing.

## Usage
See:

See:

* https://www.bfe-networks.net/en_us/modules/mod_trace/mod_trace/
* https://www.bfe-networks.net/zh_cn/modules/mod_trace/mod_trace/

0 comments on commit d8f9d66

Please sign in to comment.