Skip to content

Commit 68d8c70

Browse files
cesarParracesarParra
authored
Merge pull request #230 from cesarParra/custom-metadata-type-parsing
Custom metadata type parsing
2 parents 0dd6ef1 + 98521ab commit 68d8c70

35 files changed

+713
-107
lines changed

‎README.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -309,6 +309,15 @@ export default defineMarkdownConfig({
309309
});
310310
```
311311

312+
You can also leverage the `exclude` property to indirectly modify things like custom metadata records you do
313+
not want included in the custom metadata type object documentation.
314+
315+
```typescript
316+
//...
317+
exclude: ['**/*.md-meta.xml']
318+
//...
319+
```
320+
312321
### Excluding Tags from Appearing in the Documentation
313322

314323
Note: Only works for Markdown documentation.

‎examples/vitepress/docs/.vitepress/cache/deps/_metadata.json‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,31 @@
11
{
2-
"hash": "f2216e85",
2+
"hash": "05eb2d4f",
33
"configHash": "7f7b0dad",
4-
"lockfileHash": "76121266",
5-
"browserHash": "441a8d6a",
4+
"lockfileHash": "3a9c2374",
5+
"browserHash": "a831d6e7",
66
"optimized": {
77
"vue": {
88
"src": "../../../../node_modules/vue/dist/vue.runtime.esm-bundler.js",
99
"file": "vue.js",
10-
"fileHash": "885cbaa9",
10+
"fileHash": "1632d62a",
1111
"needsInterop": false
1212
},
1313
"vitepress > @vue/devtools-api": {
1414
"src": "../../../../node_modules/@vue/devtools-api/dist/index.js",
1515
"file": "vitepress___@vue_devtools-api.js",
16-
"fileHash": "ff3ba36c",
16+
"fileHash": "dc8fec00",
1717
"needsInterop": false
1818
},
1919
"vitepress > @vueuse/core": {
2020
"src": "../../../../node_modules/@vueuse/core/index.mjs",
2121
"file": "vitepress___@vueuse_core.js",
22-
"fileHash": "b6cc6d79",
22+
"fileHash": "3d02446b",
2323
"needsInterop": false
2424
},
2525
"@theme/index": {
2626
"src": "../../../../node_modules/vitepress/dist/client/theme-default/index.js",
2727
"file": "@theme_index.js",
28-
"fileHash": "6b17bcd7",
28+
"fileHash": "3d2d1de3",
2929
"needsInterop": false
3030
}
3131
},

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,10 @@
9393
{
9494
"text": "Speaker__c",
9595
"link": "custom-objects/Speaker__c.md"
96+
},
97+
{
98+
"text": "VisibleCMT__mdt",
99+
"link": "custom-objects/VisibleCMT__mdt.md"
96100
}
97101
]
98102
}

‎examples/vitepress/docs/changelog.md‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,4 +79,12 @@ These custom fields have been added or removed.
7979

8080
### Contact
8181

82-
- New Field: PhotoUrl__c. URL of the contact's photo
82+
- New Field: PhotoUrl__c. URL of the contact's photo
83+
84+
## New or Removed Custom Metadata Type Records
85+
86+
These custom metadata type records have been added or removed.
87+
88+
### VisibleCMT__mdt
89+
90+
- New Custom Metadata Record: Some_Record_1

‎examples/vitepress/docs/custom-objects/VisibleCMT__mdt.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
title: VisibleCMT__mdt
3+
---
4+
5+
# VisibleCMT
6+
7+
## API Name
8+
`VisibleCMT__mdt`
9+
10+
## Fields
11+
### Field1
12+
**Required**
13+
14+
**API Name**
15+
16+
`apexdocs__Field1__c`
17+
18+
**Type**
19+
20+
*Text*
21+
22+
## Records
23+
### Some Record 1
24+
25+
`Protected`
26+
27+
**API Name**
28+
29+
`VisibleCMT.Some_Record_1`

‎examples/vitepress/docs/index.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ Represents a line item on a sales order.
4949

5050
Represents a speaker at an event.
5151

52+
### [VisibleCMT__mdt](custom-objects/VisibleCMT__mdt)
53+
5254
## Miscellaneous
5355

5456
### [BaseClass](miscellaneous/BaseClass)

‎examples/vitepress/force-app/main/default/customMetadata/VisibleCMT.Some_Record_1.md-meta.xml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<CustomMetadata xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
3+
<label>Some Record 1</label>
4+
<protected>true</protected>
5+
<values>
6+
<field>Field1__c</field>
7+
<value xsi:type="xsd:string">Sample Value</value>
8+
</values>
9+
</CustomMetadata>

‎examples/vitepress/force-app/main/default/objects/SameNamespaceMDT__mdt/SameNamespaceMDT__mdt.object-meta.xml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
3+
<label>SameNamespaceMDT</label>
4+
<pluralLabel>SameNamespaceMDTs</pluralLabel>
5+
<visibility>Protected</visibility>
6+
</CustomObject>

‎examples/vitepress/force-app/main/default/objects/VisibleCMT__mdt/VisibleCMT__mdt.object-meta.xml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
3+
<label>VisibleCMT</label>
4+
<pluralLabel>VisibleCMTs</pluralLabel>
5+
<visibility>Public</visibility>
6+
</CustomObject>

‎examples/vitepress/force-app/main/default/objects/VisibleCMT__mdt/fields/Field1__c.field-meta.xml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<CustomField xmlns="http://soap.sforce.com/2006/04/metadata">
3+
<fullName>Field1__c</fullName>
4+
<externalId>false</externalId>
5+
<fieldManageability>DeveloperControlled</fieldManageability>
6+
<label>Field1</label>
7+
<length>255</length>
8+
<required>true</required>
9+
<type>Text</type>
10+
<unique>false</unique>
11+
</CustomField>

0 commit comments

Comments
 (0)