SObject support (Markdown subcommand)

examples/vitepress/apexdocs.config.ts

@@ -33,6 +33,7 @@ export default {
   }),
   markdown: defineMarkdownConfig({
     sourceDir: 'force-app',
+    includeMetadata: false,
     scope: ['global', 'public', 'protected', 'private', 'namespaceaccessible'],
     sortAlphabetically: true,
     namespace: 'apexdocs',
@@ -50,36 +51,21 @@ export default {
     },
     excludeTags: ['internal'],
     transformDocs: async (docs) => {
+      const apexOnlyDocs = docs.filter((doc) => doc.type !== 'customobject');
+      const objectOnlyDocs = docs.filter((doc) => doc.type === 'customobject');
+
       // Update sidebar
       const sidebar = [
         {
           text: 'API Reference',
-          items: [
-            {
-              text: 'Grouped By Type',
-              items: [
-                {
-                  text: 'Classes',
-                  items: docs.filter((doc) => doc.source.type === 'class').map(toSidebarLink),
-                },
-                {
-                  text: 'Interfaces',
-                  items: docs.filter((doc) => doc.source.type === 'interface').map(toSidebarLink),
-                },
-                {
-                  text: 'Enums',
-                  items: docs.filter((doc) => doc.source.type === 'enum').map(toSidebarLink),
-                },
-              ],
-            },
-            {
-              text: 'Grouped by Group',
-              items: Array.from(extractGroups(docs)).map(([groupName, groupDocs]) => ({
-                text: groupName,
-                items: groupDocs.map(toSidebarLink),
-              })),
-            },
-          ],
+          items: Array.from(extractGroups(apexOnlyDocs)).map(([groupName, groupDocs]) => ({
+            text: groupName,
+            items: groupDocs.map(toSidebarLink),
+          })),
+        },
+        {
+          text: 'Object Reference',
+          items: objectOnlyDocs.map(toSidebarLink),
         },
       ];
       await writeFileAsync('./docs/.vitepress/sidebar.json', JSON.stringify(sidebar, null, 2));

examples/vitepress/docs/.vitepress/sidebar.json

@@ -3,117 +3,89 @@
     "text": "API Reference",
     "items": [
       {
-        "text": "Grouped By Type",
+        "text": "Miscellaneous",
         "items": [
           {
-            "text": "Classes",
-            "items": [
-              {
-                "text": "BaseClass",
-                "link": "miscellaneous/BaseClass.md"
-              },
-              {
-                "text": "MultiInheritanceClass",
-                "link": "miscellaneous/MultiInheritanceClass.md"
-              },
-              {
-                "text": "SampleClass",
-                "link": "samplegroup/SampleClass.md"
-              },
-              {
-                "text": "SampleException",
-                "link": "miscellaneous/SampleException.md"
-              },
-              {
-                "text": "Url",
-                "link": "miscellaneous/Url.md"
-              }
-            ]
+            "text": "BaseClass",
+            "link": "miscellaneous/BaseClass.md"
           },
           {
-            "text": "Interfaces",
-            "items": [
-              {
-                "text": "ParentInterface",
-                "link": "miscellaneous/ParentInterface.md"
-              },
-              {
-                "text": "SampleInterface",
-                "link": "miscellaneous/SampleInterface.md"
-              }
-            ]
+            "text": "MultiInheritanceClass",
+            "link": "miscellaneous/MultiInheritanceClass.md"
           },
           {
-            "text": "Enums",
-            "items": [
-              {
-                "text": "ReferencedEnum",
-                "link": "miscellaneous/ReferencedEnum.md"
-              },
-              {
-                "text": "SampleEnum",
-                "link": "sample-enums/SampleEnum.md"
-              }
-            ]
+            "text": "ParentInterface",
+            "link": "miscellaneous/ParentInterface.md"
+          },
+          {
+            "text": "ReferencedEnum",
+            "link": "miscellaneous/ReferencedEnum.md"
+          },
+          {
+            "text": "SampleException",
+            "link": "miscellaneous/SampleException.md"
+          },
+          {
+            "text": "SampleInterface",
+            "link": "miscellaneous/SampleInterface.md"
+          },
+          {
+            "text": "Url",
+            "link": "miscellaneous/Url.md"
           }
         ]
       },
       {
-        "text": "Grouped by Group",
+        "text": "SampleGroup",
         "items": [
           {
-            "text": "Miscellaneous",
-            "items": [
-              {
-                "text": "BaseClass",
-                "link": "miscellaneous/BaseClass.md"
-              },
-              {
-                "text": "MultiInheritanceClass",
-                "link": "miscellaneous/MultiInheritanceClass.md"
-              },
-              {
-                "text": "ParentInterface",
-                "link": "miscellaneous/ParentInterface.md"
-              },
-              {
-                "text": "ReferencedEnum",
-                "link": "miscellaneous/ReferencedEnum.md"
-              },
-              {
-                "text": "SampleException",
-                "link": "miscellaneous/SampleException.md"
-              },
-              {
-                "text": "SampleInterface",
-                "link": "miscellaneous/SampleInterface.md"
-              },
-              {
-                "text": "Url",
-                "link": "miscellaneous/Url.md"
-              }
-            ]
-          },
-          {
-            "text": "SampleGroup",
-            "items": [
-              {
-                "text": "SampleClass",
-                "link": "samplegroup/SampleClass.md"
-              }
-            ]
-          },
+            "text": "SampleClass",
+            "link": "samplegroup/SampleClass.md"
+          }
+        ]
+      },
+      {
+        "text": "Sample Enums",
+        "items": [
           {
-            "text": "Sample Enums",
-            "items": [
-              {
-                "text": "SampleEnum",
-                "link": "sample-enums/SampleEnum.md"
-              }
-            ]
+            "text": "SampleEnum",
+            "link": "sample-enums/SampleEnum.md"
           }
         ]
       }
     ]
+  },
+  {
+    "text": "Object Reference",
+    "items": [
+      {
+        "text": "Event__c",
+        "link": "custom-objects/Event__c.md"
+      },
+      {
+        "text": "Price_Component__c",
+        "link": "custom-objects/Price_Component__c.md"
+      },
+      {
+        "text": "Product__c",
+        "link": "custom-objects/Product__c.md"
+      },
+      {
+        "text": "Product_Price_Component__c",
+        "link": "custom-objects/Product_Price_Component__c.md"
+      },
+      {
+        "text": "Sales_Order__c",
+        "link": "custom-objects/Sales_Order__c.md"
+      },
+      {
+        "text": "Sales_Order_Line__c",
+        "link": "custom-objects/Sales_Order_Line__c.md"
+      },
+      {
+        "text": "Speaker__c",
+        "link": "custom-objects/Speaker__c.md"
+      }
+    ]
   }
 ]

examples/vitepress/docs/custom-objects/Event__c.md

@@ -0,0 +1,65 @@
+---
+title: Event__c
+---
+
+# Event
+
+Represents an event that people can register for.
+
+## API Name
+`apexdocs__Event__c`
+
+## Fields
+### Description
+
+**API Name**
+
+`apexdocs__Description__c`
+
+**Type**
+
+*LongTextArea*
+
+---
+### End Date
+
+**API Name**
+
+`apexdocs__End_Date__c`
+
+**Type**
+
+*Date*
+
+---
+### Location
+
+**API Name**
+
+`apexdocs__Location__c`
+
+**Type**
+
+*Location*
+
+---
+### Start Date
+
+**API Name**
+
+`apexdocs__Start_Date__c`
+
+**Type**
+
+*Date*
+
+---
+### Tag Line
+
+**API Name**
+
+`apexdocs__Tag_Line__c`
+
+**Type**
+
+*Text*

examples/vitepress/docs/custom-objects/Price_Component__c.md

@@ -0,0 +1,69 @@
+---
+title: Price_Component__c
+---
+
+# Price Component
+
+## API Name
+`apexdocs__Price_Component__c`
+
+## Fields
+### Description
+
+**API Name**
+
+`apexdocs__Description__c`
+
+**Type**
+
+*Text*
+
+---
+### Expression
+
+The Expression that determines if this price should take effect or not.
+
+**API Name**
+
+`apexdocs__Expression__c`
+
+**Type**
+
+*LongTextArea*
+
+---
+### Percent
+
+Use this field to calculate the price based on the list price's percentage instead of providing a flat price.
+
+**API Name**
+
+`apexdocs__Percent__c`
+
+**Type**
+
+*Percent*
+
+---
+### Price
+
+Use this when the Price Component represents a Flat Price. To represent a Percentage use the Percent field.
+
+**API Name**
+
+`apexdocs__Price__c`
+
+**Type**
+
+*Currency*
+
+---
+### Type
+
+**API Name**
+
+`apexdocs__Type__c`
+
+**Type**
+
+*Picklist*