Skip to content

Commit fa0b5c5

Browse files
cesarParracesarParra
authored
Readme images (#199)
1 parent 4f03bff commit fa0b5c5

26 files changed

+140
-75
lines changed

‎.github/workflows/close_stale.yml‎

Lines changed: 0 additions & 22 deletions
This file was deleted.

‎README.md‎

Lines changed: 58 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,64 @@
99
</div>
1010

1111
ApexDocs is a non-opinionated documentation generator for Salesforce Apex classes.
12-
It can output documentation in Markdown
13-
format,
14-
which allows you to use the Static Site Generator of your choice to create a documentation site that fits your needs,
15-
hosted in any static web hosting service.
12+
It can output documentation in Markdown format, which allows you to use the Static Site Generator of your choice to
13+
create a documentation site that fits your needs, hosted in any static web hosting service.
14+
15+
## 👀 Examples
16+
17+
ApexDocs generates Markdown files, which can be integrated into any Static Site Generation (SSG) engine,
18+
(e.g. Jekyll, Vitepress, Hugo, Docosaurus, etc.) to create a documentation site that fits your needs.
19+
20+
This gives you the flexibility to create beautiful leveraging your preferred SSG engine, which
21+
usually provides a wide range of themes, dark mode support, and other features out of the box.
22+
23+
<div align="center">
24+
<img src="imgs/vitepress-light.png" alt="Vitepress Light" width="45%" />
25+
<img src="imgs/vitepress-dark.png" alt="Vitepress Dark" width="45%" />
26+
</div>
27+
28+
*These are examples of documentation sites generated using Vitepress.
29+
Head over to the `examples/vitepress` folder to see the code.*
30+
31+
The extra flexibility also lets you integrate the output documentation with your existing documentation site,
32+
allowing you to match the look and feel of your existing site.
33+
34+
<div align="center">
35+
<img src="imgs/integration.png" alt="Integration" width="70%" />
36+
</div>
37+
38+
OpenApi REST definitions can be visualized using a tool like ReDoc, Swagger UI, or any other OpenApi viewer.
39+
40+
<div align="center">
41+
<img src="imgs/redocly.png" alt="OpenApi" width="70%" />
42+
</div>
43+
44+
This repo contains several other example implementations in the `examples` directory, showcasing how to integrate
45+
with different tools.
46+
47+
* [Examples](./examples)
48+
49+
### In the wild
50+
51+
Here are some live projects using ApexDocs:
52+
53+
- [Trailhead Apex Recipes](https://github.com/trailheadapps/apex-recipes)
54+
- [Salesforce Commerce Apex Reference](https://developer.salesforce.com/docs/commerce/salesforce-commerce/references/comm-apex-reference/cart-reference.html)
55+
- [Expression (API)](https://cesarparra.github.io/expression/)
56+
- [Nimble AMS Docs](https://nimbleuser.github.io/nams-api-docs/#/api-reference/)
57+
58+
## 🚀 Features
59+
60+
* Generate documentation for Salesforce Apex classes as Markdown files
61+
* Generate an OpenApi REST specification based on `@RestResource` classes
62+
* Generate a changelog based on the differences between two versions of your Salesforce Apex classes
63+
* Support for grouping blocks of related code within a class
64+
* Support for ignoring files and members from being documented
65+
* Namespace support
66+
* Configuration file support
67+
* Single line ApexDoc Blocks
68+
* Custom tag support
69+
* And much, much more!
1670

1771
## 💿 Installation
1872

@@ -49,38 +103,6 @@ Run the following command to generate a changelog for your Salesforce Apex class
49103
apexdocs changelog --previousVersionDir force-app-previous --currentVersionDir force-app
50104
```
51105

52-
## 🚀 Features
53-
54-
* Generate documentation for Salesforce Apex classes as Markdown files
55-
* Generate an OpenApi REST specification based on `@RestResource` classes
56-
* Generate a changelog based on the differences between two versions of your Salesforce Apex classes
57-
* Support for grouping blocks of related code within a class
58-
* Support for ignoring files and members from being documented
59-
* Namespace support
60-
* Configuration file support
61-
* Single line ApexDoc Blocks
62-
* Custom tag support
63-
* And much, much more!
64-
65-
## 👀 Demo
66-
67-
ApexDocs generates Markdown files, which can be integrated into any Static Site Generation engine,
68-
(e.g. Jekyll, Vitepress, Hugo, Docosaurus, etc.) to create a documentation site that fits your needs.
69-
70-
This repo contains several example implementations in the `examples` directory, showcasing how to integrate
71-
with some of these tools.
72-
73-
* [Examples](./examples)
74-
75-
### In the wild
76-
77-
Here are some live projects using ApexDocs:
78-
79-
- [Trailhead Apex Recipes](https://github.com/trailheadapps/apex-recipes)
80-
- [Salesforce Commerce Apex Reference](https://developer.salesforce.com/docs/commerce/salesforce-commerce/references/comm-apex-reference/cart-reference.html)
81-
- [Expression (API)](https://cesarparra.github.io/expression/)
82-
- [Nimble AMS Docs](https://nimbleuser.github.io/nams-api-docs/#/api-reference/)
83-
84106
## ▶️ Available Commands
85107

86108
### Markdown

‎examples/open-api/docs/openapi.json‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
}
1111
],
1212
"paths": {
13-
"AccountService/": {
13+
"/AccountService/": {
1414
"description": "Account related operations",
1515
"get": {
1616
"tags": [
@@ -338,7 +338,7 @@
338338
}
339339
}
340340
},
341-
"Contact/": {
341+
"/Contact/": {
342342
"description": "Contact related operations",
343343
"get": {
344344
"tags": [
@@ -359,7 +359,7 @@
359359
}
360360
}
361361
},
362-
"Order/": {
362+
"/Order/": {
363363
"description": "Order related operations",
364364
"get": {
365365
"tags": [

‎examples/open-api/force-app/main/default/classes/dto/ChildClass.cls-meta.xml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
3+
<apiVersion>62.0</apiVersion>
4+
<status>Active</status>
5+
</ApexClass>

‎examples/open-api/force-app/main/default/classes/dto/Reference1.cls-meta.xml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
3+
<apiVersion>62.0</apiVersion>
4+
<status>Active</status>
5+
</ApexClass>

‎examples/open-api/force-app/main/default/classes/dto/Reference2.cls-meta.xml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
3+
<apiVersion>62.0</apiVersion>
4+
<status>Active</status>
5+
</ApexClass>

‎examples/open-api/force-app/main/default/classes/dto/Reference3.cls-meta.xml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
3+
<apiVersion>62.0</apiVersion>
4+
<status>Active</status>
5+
</ApexClass>

‎examples/open-api/force-app/main/default/classes/dto/Reference4.cls-meta.xml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
3+
<apiVersion>62.0</apiVersion>
4+
<status>Active</status>
5+
</ApexClass>

‎examples/open-api/force-app/main/default/classes/dto/Reference5.cls-meta.xml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
3+
<apiVersion>62.0</apiVersion>
4+
<status>Active</status>
5+
</ApexClass>

‎examples/open-api/force-app/main/default/classes/dto/Reference6.cls-meta.xml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
3+
<apiVersion>62.0</apiVersion>
4+
<status>Active</status>
5+
</ApexClass>

0 commit comments

Comments
 (0)