docs: add listing page doc

thegalactiks · Nov 11, 2023 · 3fa1446 · 3fa1446
1 parent 016369f
commit 3fa1446
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/docs/contents/listing-page.md b/docs/contents/listing-page.md
@@ -0,0 +1,19 @@
+# Listing Page
+
+Listing pages are automatically created when an `isPartOf` is filled in your content. But, you may want to customize this listing page with specific contents or title and description for SEO purposes for example.
+
+Here an example of how to create a listing page :
+
+```markdown:index.mdx
+---
+name: My website category
+description: This category will help you find relevant content about the category topic.
+identifier: category
+inLanguage: en
+listingPage: true
+dateCreated: 2023-11-11T09:50:33.571Z
+dateModified: 2023-11-11T09:51:19.968Z
+---
+
+Additional contents. The content will be listed below or a above depending on the theme project used.
+```
diff --git a/sidebars.js b/sidebars.js
@@ -28,6 +28,7 @@ const sidebars = {
       collapsed: true,
       items: [
         'contents/article',
+        'contents/listing-page',
         'contents/creative-work',
         'contents/organization',
         'contents/page',