-
-
Notifications
You must be signed in to change notification settings - Fork 62
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
167 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
**ENUM** | ||
# `CodeBlockStyle` | ||
|
||
**Contents** | ||
- [Cases](#cases) | ||
- `indented` | ||
- `backticks` | ||
|
||
**Declaration** | ||
```swift | ||
public enum CodeBlockStyle | ||
``` | ||
|
||
|
||
|
||
> Markdown format for the generated code block | ||
> | ||
> - indented: Code block is indented by 4-spaces | ||
> - backticks: Code block is wrapped with ``` | ||
|
||
## Cases | ||
### `indented` | ||
|
||
**Declaration** | ||
```swift | ||
case indented | ||
``` | ||
|
||
|
||
|
||
|
||
|
||
### `backticks` | ||
|
||
**Declaration** | ||
```swift | ||
case backticks(language: String) | ||
``` | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
42 changes: 42 additions & 0 deletions
42
Docs/Reference/MarkdownGenerator/structs/MarkdownCodeBlock.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
**STRUCT** | ||
# `MarkdownCodeBlock` | ||
|
||
**Contents** | ||
- [Properties](#properties) | ||
- `markdown` | ||
- [Methods](#methods) | ||
- `init(code:style:)` | ||
|
||
**Declaration** | ||
```swift | ||
public struct MarkdownCodeBlock: MarkdownConvertible | ||
``` | ||
|
||
|
||
|
||
|
||
|
||
## Properties | ||
### `markdown` | ||
|
||
**Declaration** | ||
```swift | ||
public var markdown: String | ||
``` | ||
|
||
|
||
|
||
> Generated Markdown output | ||
|
||
## Methods | ||
### `init(code:style:)` | ||
|
||
**Declaration** | ||
```swift | ||
public init(code: String, style: CodeBlockStyle = .indented) | ||
``` | ||
|
||
|
||
|
||
|
||
|
42 changes: 42 additions & 0 deletions
42
Docs/Reference/MarkdownGenerator/structs/MarkdownCollapsibleSection.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
**STRUCT** | ||
# `MarkdownCollapsibleSection` | ||
|
||
**Contents** | ||
- [Properties](#properties) | ||
- `markdown` | ||
- [Methods](#methods) | ||
- `init(summary:details:)` | ||
|
||
**Declaration** | ||
```swift | ||
public struct MarkdownCollapsibleSection: MarkdownConvertible | ||
``` | ||
|
||
|
||
|
||
|
||
|
||
## Properties | ||
### `markdown` | ||
|
||
**Declaration** | ||
```swift | ||
public var markdown: String | ||
``` | ||
|
||
|
||
|
||
> Generated Markdown output | ||
|
||
## Methods | ||
### `init(summary:details:)` | ||
|
||
**Declaration** | ||
```swift | ||
public init(summary: String, details: MarkdownConvertible) | ||
``` | ||
|
||
|
||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
.PHONY: docs | ||
|
||
docs: | ||
rm -rf Docs/Reference/MarkdownGenerator | ||
sourcedocs --spm-module MarkdownGenerator | ||
|