chore: improve docs formatting

unjs · Feb 8, 2024 · 816bebb · 816bebb
1 parent 8801856
commit 816bebb
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 23 deletions.
diff --git a/docs/1.guide/4.generators.md b/docs/1.guide/4.generators.md
@@ -1,6 +1,6 @@
 # Generators
 
-Automd uses an extendable system of generators that are responsible to maintain each `<-- automd` section.
+Automd uses an extendable system of generators that are responsible to maintain each `<-- automd:name -->` section.
 
 There are several available generators for automd each supporting different arguments.
 

diff --git a/docs/2.generators/badges.md b/docs/2.generators/badges.md
@@ -4,19 +4,23 @@ The `badges` generator generates badges for the latest npm version, npm download
 
 ## Usage
 
-    <!-- automd:badges color=yellow name=defu codecov bundlephobia -->
-    <!-- /automd -->
+```md
+<!-- automd:badges color=yellow name=defu codecov bundlephobia -->
+<!-- /automd -->
+```
 
 **Updated Result:**
 
-    <!-- automd:badges color=yellow name=defu codecov bundlephobia -->
+```md
+<!-- automd:badges color=yellow name=defu codecov bundlephobia -->
 
-    [![npm version](https://flat.badgen.net/npm/v/defu?color=yellow)](https://npmjs.com/package/defu)
-    [![npm downloads](https://flat.badgen.net/npm/dm/defu?color=yellow)](https://npmjs.com/package/defu)
-    [![bundle size](https://flat.badgen.net/bundlephobia/minzip/defu?color=yellow)](https://bundlephobia.com/package/defu)
-    [![codecov](https://flat.badgen.net/codecov/c/github/unjs/automd?color=yellow)](https://codecov.io/gh/unjs/automd)
+[![npm version](https://flat.badgen.net/npm/v/defu?color=yellow)](https://npmjs.com/package/defu)
+[![npm downloads](https://flat.badgen.net/npm/dm/defu?color=yellow)](https://npmjs.com/package/defu)
+[![bundle size](https://flat.badgen.net/bundlephobia/minzip/defu?color=yellow)](https://bundlephobia.com/package/defu)
+[![codecov](https://flat.badgen.net/codecov/c/github/unjs/automd?color=yellow)](https://codecov.io/gh/unjs/automd)
 
-    <!-- /automd -->
+<!-- /automd -->
+```
 
 ## Arguments
 

diff --git a/docs/2.generators/jsdocs.md b/docs/2.generators/jsdocs.md
@@ -6,26 +6,31 @@ Internally it uses [untyped](https://untyped.unjs.io/) and [jiti](https://github
 
 ## Usage
 
-    <!-- automd:jsdocs src="./src/index" -->
-    <!-- /automd -->
+```md
+<!-- automd:jsdocs src="./src/index" -->
+<!-- /automd -->
+```
 
 > [!NOTE]
 > Make sure you have some utility exports in `src/index.ts` annotated with JSDocs.
 
 **Updated Result:**
 
-    <!-- automd:jsdocs src="./src/index" -->
+````md
+<!-- automd:jsdocs src="./src/index" -->
 
-    ### `add(a, b)`
+### `add(a, b)`
 
-    Adds two numbers together.
+Adds two numbers together.
 
-    **Example:**
-    ```js
-    add(1, 2); // 3
-    ```
+**Example:**
 
-    <!-- /automd -->
+```js
+add(1, 2); // 3
+```
+
+<!-- /automd -->
+````
 
 ## Arguments
 

diff --git a/docs/2.generators/pm-install.md b/docs/2.generators/pm-install.md
@@ -4,8 +4,10 @@ The `pm-install` or `pm-i` generator generates installation commands for several
 
 ## Usage
 
-    <!-- automd:pm-install name=package-name dev -->
-    <!-- /automd -->
+```md
+<!-- automd:pm-install name=package-name dev -->
+<!-- /automd -->
+```
 
 **Updated Result:**
 

diff --git a/docs/2.generators/pm-x.md b/docs/2.generators/pm-x.md
@@ -4,8 +4,10 @@ The `pm-x` generator generates commands for running/executing a package through
 
 ## Usage
 
-    <!-- automd:pm-x name="package-name" args="[files] <flags>" -->
-    <!-- /automd -->
+```md
+<!-- automd:pm-x name="package-name" args="[files] <flags>" -->
+<!-- /automd -->
+```
 
 **Updated Result:**