Skip to content

Commit

Permalink
feat: HelpInfo.SaveJson ( Fixes #207 )
Browse files Browse the repository at this point in the history
  • Loading branch information
StartAutomating authored and StartAutomating committed Oct 13, 2024
1 parent f303eb2 commit 493ebd3
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions docs/HelpInfo/SaveJson.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
HelpInfo.SaveJson()
-------------------

### Synopsis
Saves a Help Topic as json

---

### Description

Saves a Help Topic to a json file.

---

### Related Links
* HelpInfo.ToJson

---

### Examples
> EXAMPLE 1
```PowerShell
(Get-MarkdownHelp Get-MarkdownHelp).SaveJson(".\test.json")
```

---

### Parameters
#### **FilePath**
The path to the file.
If this does not exist it will be created.

|Type |Required|Position|PipelineInput|
|----------|--------|--------|-------------|
|`[String]`|false |1 |false |

---

### Notes
This will not save to files that have illegal names on Windows.

---

0 comments on commit 493ebd3

Please sign in to comment.