Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
eneko committed Oct 19, 2017
1 parent d579ece commit 9c8c3fe
Show file tree
Hide file tree
Showing 7 changed files with 167 additions and 5 deletions.
23 changes: 18 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,26 @@
## Master

#### Breaking
### Changes
- None

#### Enhancements
- None

#### Bug Fixes
- None
## 0.2.0

### Enhancements
- Add MarkdownCodeBlock
- Add MarkdownCollapsibleSection


## 0.1.2

### Changes
- Revert Blockquote formatting for proper rendering on GitHub.com


## 0.1.1

### Changes
- Remove Blockquote for empty lines


## 0.1.0
Expand Down
3 changes: 3 additions & 0 deletions Docs/Reference/MarkdownGenerator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ Run `sourcedocs` in the repository root to update this documentation.
## Structs

- [MarkdownBlockquotes](/Docs/Reference/MarkdownGenerator/structs/MarkdownBlockquotes.md)
- [MarkdownCodeBlock](/Docs/Reference/MarkdownGenerator/structs/MarkdownCodeBlock.md)
- [MarkdownCollapsibleSection](/Docs/Reference/MarkdownGenerator/structs/MarkdownCollapsibleSection.md)
- [MarkdownFile](/Docs/Reference/MarkdownGenerator/structs/MarkdownFile.md)
- [MarkdownHeader](/Docs/Reference/MarkdownGenerator/structs/MarkdownHeader.md)
- [MarkdownImage](/Docs/Reference/MarkdownGenerator/structs/MarkdownImage.md)
Expand All @@ -20,6 +22,7 @@ Run `sourcedocs` in the repository root to update this documentation.

## Enums

- [CodeBlockStyle](/Docs/Reference/MarkdownGenerator/enums/CodeBlockStyle.md)
- [MarkdownListStyle](/Docs/Reference/MarkdownGenerator/enums/MarkdownListStyle.md)

## Extensions
Expand Down
45 changes: 45 additions & 0 deletions Docs/Reference/MarkdownGenerator/enums/CodeBlockStyle.md
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)
```







11 changes: 11 additions & 0 deletions Docs/Reference/MarkdownGenerator/extensions/String.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,14 @@ public var markdown: String

> Render a string of text as Markdown. No transformations applied.
### `removingConsecutiveBlankLines`

**Declaration**
```swift
public var removingConsecutiveBlankLines: String
```



> Remove consecutive blank lines from a string output
42 changes: 42 additions & 0 deletions Docs/Reference/MarkdownGenerator/structs/MarkdownCodeBlock.md
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)
```





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)
```





6 changes: 6 additions & 0 deletions Makefile
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

0 comments on commit 9c8c3fe

Please sign in to comment.