Add inline comment to code blocks in docs

Signed-off-by: windsonsea <[email protected]>
DaoCloud · Jan 19, 2024 · df627e3 · df627e3
1 parent 77e06f3
commit df627e3
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 5 deletions.
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -45,6 +45,12 @@ markdown_extensions:
       smart_enable: all
   - pymdownx.tabbed:
       alternate_style: true
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
 
 nav:
   - README.md

diff --git a/docs/usage/install/underlay/get-started-calico-zh_CN.md b/docs/usage/install/underlay/get-started-calico-zh_CN.md
@@ -225,7 +225,7 @@ spec:
   template:
     metadata:
       annotations:
-        ipam.spidernet.io/ippool: '{"ipv4":["nginx-ippool-v4"]}'
+        ipam.spidernet.io/ippool: '{"ipv4":["nginx-ippool-v4"]}' # (1)
       labels:
         app: nginx
     spec:
@@ -240,8 +240,7 @@ spec:
 EOF
 ```
 
-> `ipam.spidernet.io/ippool`: 从 "nginx-ippool-v4" SpiderIPPool 中分配固定 IP
->
+1. 从 "nginx-ippool-v4" SpiderIPPool 中分配固定 IP
 
 当应用 Pod 被创建，Spiderpool 从 annnotations 指定的 `ippool: nginx-ippool-v4` 中给 Pod 分配 IP。
 

diff --git a/docs/usage/install/underlay/get-started-calico.md b/docs/usage/install/underlay/get-started-calico.md
@@ -225,7 +225,7 @@ spec:
   template:
     metadata:
       annotations:
-        ipam.spidernet.io/ippool: '{"ipv4":["nginx-ippool-v4"]}'
+        ipam.spidernet.io/ippool: '{"ipv4":["nginx-ippool-v4"]}' # (1)
       labels:
         app: nginx
     spec:
@@ -240,7 +240,7 @@ spec:
 EOF
 ```
 
-> `ipam.spidernet.io/ippool`: Assign static IPs from "nginx-ippool-v4" SpiderIPPool
+1. Assign static IPs from "nginx-ippool-v4" SpiderIPPool
 
 When the application Pod is created, Spiderpool assigns the IP to the Pod from the `ippool: nginx-ippool-v4` specified in the annnotations.