Skip to content

Doc updates #176

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 15, 2024
Merged

Doc updates #176

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,11 @@ Here are some live projects using ApexDocs:

## ▶️ Available Commands

### Markdown

`markdown`

### Flags
#### Flags

| Flag | Alias | Description | Default | Required |
|------------------------|-------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|----------|
Expand All @@ -89,7 +91,7 @@ Here are some live projects using ApexDocs:
| `--includeMetadata ` | N/A | Whether to include the file's meta.xml information: Whether it is active and and the API version | `false` | No |
| `--linkingStrategy` | N/A | The strategy to use when linking to other classes. Possible values are `relative`, `no-link`, and `none` | `relative` | No |

#### Linking Strategy
##### Linking Strategy

The linking strategy determines how ApexDocs will link to other classes in your documentation. For example,
if I have class `A` that links through class `B` (e.g. through an `{@link B}` tag, the `@see` tag,
Expand All @@ -115,15 +117,19 @@ Does not apply any kind of logic. Instead, the links will be determined by the p
from the root of the documentation site OR by whatever path you have returned in the `transformReference` hook
for the file.

### Sample Usage
#### Sample Usage

```bash
apexdocs markdown -s force-app -t docs -p global public namespaceaccessible -n MyNamespace
```

---

### OpenApi

`openapi`

### Flags
#### Flags

| Flag | Alias | Description | Default | Required |
|----------------|-------|-------------------------------------------------------------------------------|-----------------|----------|
Expand All @@ -134,7 +140,7 @@ apexdocs markdown -s force-app -t docs -p global public namespaceaccessible -n M
| `--title` | N/A | The title of the OpenApi file. | `Apex REST API` | No |
| `--apiVersion` | N/A | The version of the API. | `1.0.0` | No |

### Sample Usage
#### Sample Usage

```bash
apexdocs openapi -s force-app -t docs -n MyNamespace --title "My Custom OpenApi Title"
Expand Down