chore(example): replace Lorem with Pipeline (#773)

fuxingloh · Feb 2, 2024 · 7975c19 · 7975c19
1 parent 0404a17
commit 7975c19
Show file tree

Hide file tree

Showing 5 changed files with 39 additions and 123 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,5 +1,3 @@
 #### What this PR does / why we need it:
 
 #### Which issue(s) will this PR fix?:
-
-#### Additional notes:
diff --git a/example/contented.config.mjs b/example/contented.config.mjs
@@ -58,8 +58,8 @@ const config = {
         },
       },
       {
-        type: 'Lorem',
-        dir: 'example/lorem',
+        type: 'Pipeline',
+        dir: 'example/pipeline',
         pattern: ['**/*.md'],
         processor: 'md',
       },

diff --git a/example/lorem/0-lorem-1.md b/example/lorem/0-lorem-1.md
diff --git a/example/lorem/1-lorem-2.md b/example/lorem/1-lorem-2.md
diff --git a/example/pipeline/example.md b/example/pipeline/example.md
@@ -0,0 +1,37 @@
+# Pipeline
+
+You can create another pipeline by adding a new unique `type` field.
+The same `type` are grouped together and processed in the order they are defined.
+
+:::codeblock-header{filename="contented.config.mjs" language="JavaScript"}
+
+```js
+/** @type {import('@contentedjs/contented').ContentedConfig} */
+const config = {
+  processor: {
+    pipelines: [
+      {
+        type: 'Contented',
+        pattern: 'README.md',
+        processor: 'md',
+      },
+      {
+        type: 'Contented',
+        dir: 'example/docs',
+        pattern: '**/*.md',
+        processor: 'md',
+      },
+      {
+        type: 'Pipeline',
+        dir: 'example/pipeline',
+        pattern: ['**/*.md'],
+        processor: 'md',
+      },
+    ],
+  },
+};
+
+export default config;
+```
+
+:::