rdoc-markdown 0.17.2 → 0.18.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +3 -1
- data/Gemfile.lock +2 -2
- data/example/Bird.md +11 -12
- data/example/Duck.md +14 -25
- data/example/Object.md +7 -6
- data/example/Waterfowl.md +7 -6
- data/example/jekyll-seo-tag/Jekyll/SeoTag/AuthorDrop.md +12 -16
- data/example/jekyll-seo-tag/Jekyll/SeoTag/Drop.md +34 -78
- data/example/jekyll-seo-tag/Jekyll/SeoTag/Filters.md +8 -6
- data/example/jekyll-seo-tag/Jekyll/SeoTag/ImageDrop.md +12 -13
- data/example/jekyll-seo-tag/Jekyll/SeoTag/JSONLD.md +9 -10
- data/example/jekyll-seo-tag/Jekyll/SeoTag/JSONLDDrop.md +15 -26
- data/example/jekyll-seo-tag/Jekyll/SeoTag/UrlHelper.md +5 -2
- data/example/jekyll-seo-tag/Jekyll/SeoTag.md +16 -24
- data/example/jekyll-seo-tag/Jekyll.md +4 -2
- data/example/jekyll-seo-tag/Liquid/Tag.md +5 -2
- data/example/jekyll-seo-tag/Liquid.md +5 -2
- data/lib/rdoc/generator/markdown.rb +3 -2
- data/lib/rdoc/markdown/version.rb +1 -1
- data/lib/templates/classfile.md.erb +14 -11
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 6769180d689a0858bfe6af579ea16ae9bbe1a4aa8ff6471bdf0e145731a3621b
|
|
4
|
+
data.tar.gz: 4e9c43e702b50a7e894f1cea99418c1c3e0d9c1070ec9b5b41fa8dc654e97df6
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 17214dddbe75a0f4496e3ab7d818b005ebfc800bb6d9c11b6c8e946f36d409054b898024f332dddb7b99025cf6704a429ad723e5d0205c34a5d264c4cf019e2f
|
|
7
|
+
data.tar.gz: 180c0790a847153dd2368c273e721a92ce6cea08119cd2d2445d5a0a88c609ae7d5a074753916a56e4f61307ad370d7f2dcc0345983de9c008bc1c6c7e0cefd4
|
data/CHANGELOG.md
CHANGED
data/Gemfile.lock
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
PATH
|
|
2
2
|
remote: .
|
|
3
3
|
specs:
|
|
4
|
-
rdoc-markdown (0.
|
|
4
|
+
rdoc-markdown (0.18.0)
|
|
5
5
|
csv
|
|
6
6
|
erb
|
|
7
7
|
rdoc (>= 8.0)
|
|
@@ -108,7 +108,7 @@ GEM
|
|
|
108
108
|
nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
|
|
109
109
|
rainbow (3.1.1)
|
|
110
110
|
rake (13.4.2)
|
|
111
|
-
rbs (4.1.
|
|
111
|
+
rbs (4.1.2)
|
|
112
112
|
logger
|
|
113
113
|
prism (>= 1.6.0)
|
|
114
114
|
tsort
|
data/example/Bird.md
CHANGED
|
@@ -1,21 +1,20 @@
|
|
|
1
|
-
<a id="class-bird"></a>
|
|
2
|
-
|
|
3
|
-
|
|
1
|
+
# Class Bird<a id="class-bird"></a>
|
|
2
|
+
| | |
|
|
3
|
+
| --- | --- |
|
|
4
|
+
| **Inherits** | [Object](Object.md) |
|
|
5
|
+
| **Defined in** | example.rb |
|
|
4
6
|
|
|
5
|
-
|
|
7
|
+
The base class for all birds.
|
|
6
8
|
|
|
7
|
-
|
|
8
|
-
|
|
9
|
+
## Public Instance Methods
|
|
10
|
+
### `fly(direction: string, velocity: number) -> bool`<a id="method-i-fly"></a>
|
|
9
11
|
Fly somewhere.
|
|
10
12
|
|
|
11
13
|
Flying is the most critical feature of birds.
|
|
12
14
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
```
|
|
15
|
+
#### Example<a id="method-i-fly-label-Example"></a><a id="method-i-fly-example"></a>
|
|
16
|
+
```ruby
|
|
16
17
|
fly(:south, 70)
|
|
17
18
|
```
|
|
18
|
-
|
|
19
|
-
<a id="method-i-speak"></a>
|
|
20
|
-
#### `speak() { |text| ... }`
|
|
19
|
+
### `speak() { |text| ... }`<a id="method-i-speak"></a>
|
|
21
20
|
Produce some noise.
|
data/example/Duck.md
CHANGED
|
@@ -1,5 +1,10 @@
|
|
|
1
|
-
<a id="class-duck"></a>
|
|
2
|
-
|
|
1
|
+
# Class Duck<a id="class-duck"></a>
|
|
2
|
+
| | |
|
|
3
|
+
| --- | --- |
|
|
4
|
+
| **Inherits** | [Object](Object.md) |
|
|
5
|
+
| **Includes** | [Waterfowl](Waterfowl.md) |
|
|
6
|
+
| **Defined in** | example.rb |
|
|
7
|
+
|
|
3
8
|
A duck is a [`Waterfowl`](Waterfowl.md) [`Bird`](Bird.md).
|
|
4
9
|
|
|
5
10
|
Features:
|
|
@@ -14,43 +19,27 @@ waterfowl:
|
|
|
14
19
|
- swim
|
|
15
20
|
|
|
16
21
|
## Bird overrides
|
|
17
|
-
|
|
18
22
|
### Public Instance Methods
|
|
19
|
-
|
|
20
|
-
<a id="method-i-speak"></a>
|
|
21
|
-
#### `speak() { |speech| ... }`
|
|
23
|
+
#### `speak() { |speech| ... }`<a id="method-i-speak"></a>
|
|
22
24
|
[`Duck`](Duck.md) overrides generic implementation.
|
|
23
|
-
|
|
24
25
|
## Duck extensions
|
|
25
|
-
|
|
26
26
|
### Constants
|
|
27
|
-
|
|
28
|
-
<a id="MAX_VELOCITY"></a>
|
|
29
|
-
#### `MAX_VELOCITY`
|
|
27
|
+
#### `MAX_VELOCITY`<a id="MAX_VELOCITY"></a>
|
|
30
28
|
Not documented.
|
|
31
29
|
|
|
32
30
|
### Attributes
|
|
33
|
-
|
|
34
|
-
<a id="attribute-i-domestic"></a>
|
|
35
|
-
#### `domestic` [RW]
|
|
31
|
+
#### `domestic` [RW]<a id="attribute-i-domestic"></a>
|
|
36
32
|
True for domestic ducks.
|
|
37
33
|
|
|
38
|
-
<a id="attribute-i-rubber"></a>
|
|
39
|
-
#### `rubber` [R]
|
|
34
|
+
#### `rubber` [R]<a id="attribute-i-rubber"></a>
|
|
40
35
|
True for rubber ducks.
|
|
41
36
|
|
|
42
37
|
### Public Class Methods
|
|
43
|
-
|
|
44
|
-
<a id="method-c-new"></a>
|
|
45
|
-
#### `new(domestic, rubber)`
|
|
38
|
+
#### `new(domestic, rubber)`<a id="method-c-new"></a>
|
|
46
39
|
Creates a new duck.
|
|
47
|
-
|
|
48
|
-
<a id="method-c-rubber_ducks"></a>
|
|
49
|
-
#### `rubber_ducks()`
|
|
40
|
+
#### `rubber_ducks()`<a id="method-c-rubber_ducks"></a>
|
|
50
41
|
Returns list of all rubber ducks.
|
|
51
42
|
|
|
52
43
|
### Public Instance Methods
|
|
53
|
-
|
|
54
|
-
<a id="method-i-useful-3F"></a>
|
|
55
|
-
#### `useful? -> bool`
|
|
44
|
+
#### `useful? -> bool`<a id="method-i-useful-3F"></a>
|
|
56
45
|
Checks if this duck is a useful one.
|
data/example/Object.md
CHANGED
|
@@ -1,8 +1,9 @@
|
|
|
1
|
-
<a id="class-object"></a>
|
|
2
|
-
|
|
1
|
+
# Class Object<a id="class-object"></a>
|
|
2
|
+
| | |
|
|
3
|
+
| --- | --- |
|
|
4
|
+
| **Inherits** | BasicObject |
|
|
5
|
+
| **Defined in** | example.rb |
|
|
3
6
|
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
<a id="DEFAULT_DUCK_VELOCITY"></a>
|
|
7
|
-
#### `DEFAULT_DUCK_VELOCITY`
|
|
7
|
+
## Constants
|
|
8
|
+
### `DEFAULT_DUCK_VELOCITY`<a id="DEFAULT_DUCK_VELOCITY"></a>
|
|
8
9
|
Default velocity for a flying duck.
|
data/example/Waterfowl.md
CHANGED
|
@@ -1,9 +1,10 @@
|
|
|
1
|
-
<a id="module-waterfowl"></a>
|
|
2
|
-
|
|
3
|
-
|
|
1
|
+
# Module Waterfowl<a id="module-waterfowl"></a>
|
|
2
|
+
| | |
|
|
3
|
+
| --- | --- |
|
|
4
|
+
| **Defined in** | example.rb |
|
|
4
5
|
|
|
5
|
-
|
|
6
|
+
A mixin for waterfowl creatures.
|
|
6
7
|
|
|
7
|
-
|
|
8
|
-
|
|
8
|
+
## Public Instance Methods
|
|
9
|
+
### `swim()`<a id="method-i-swim"></a>
|
|
9
10
|
Swimming helper.
|
|
@@ -1,5 +1,9 @@
|
|
|
1
|
-
<a id="class-jekyll-seotag-authordrop"></a>
|
|
2
|
-
|
|
1
|
+
# Class Jekyll::SeoTag::AuthorDrop<a id="class-jekyll-seotag-authordrop"></a>
|
|
2
|
+
| | |
|
|
3
|
+
| --- | --- |
|
|
4
|
+
| **Inherits** | Jekyll::Drops::Drop |
|
|
5
|
+
| **Defined in** | lib/jekyll-seo-tag/author_drop.rb |
|
|
6
|
+
|
|
3
7
|
A drop representing the current page’s author
|
|
4
8
|
|
|
5
9
|
Author name will be pulled from:
|
|
@@ -12,24 +16,16 @@ Author name will be pulled from:
|
|
|
12
16
|
|
|
13
17
|
If the result from the name search is a string, we’ll also check for additional author metadata in `site.data.authors`
|
|
14
18
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
<a id="method-c-new"></a>
|
|
18
|
-
#### `new(page: nil, site: nil)`
|
|
19
|
+
## Public Class Methods
|
|
20
|
+
### `new(page: nil, site: nil)`<a id="method-c-new"></a>
|
|
19
21
|
Initialize a new [`AuthorDrop`](AuthorDrop.md)
|
|
20
22
|
|
|
21
23
|
page - The page hash (e.g., Page#to\_liquid) site - The Jekyll::Drops::SiteDrop
|
|
22
24
|
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
<a id="method-i-name"></a>
|
|
26
|
-
#### `name()`
|
|
25
|
+
## Public Instance Methods
|
|
26
|
+
### `name()`<a id="method-i-name"></a>
|
|
27
27
|
[`AuthorDrop#to_s`](AuthorDrop.md#method-i-to_s) should return name, allowing the author drop to safely replace `page.author`, if necessary, and remain backwards compatible
|
|
28
|
-
|
|
29
|
-
<a id="method-i-to_s"></a>
|
|
30
|
-
#### `to_s()`
|
|
28
|
+
### `to_s()`<a id="method-i-to_s"></a>
|
|
31
29
|
Alias for: [`name`](#method-i-name)
|
|
32
|
-
|
|
33
|
-
<a id="method-i-twitter"></a>
|
|
34
|
-
#### `twitter()`
|
|
30
|
+
### `twitter()`<a id="method-i-twitter"></a>
|
|
35
31
|
Not documented.
|
|
@@ -1,108 +1,64 @@
|
|
|
1
|
-
<a id="class-jekyll-seotag-drop"></a>
|
|
2
|
-
|
|
1
|
+
# Class Jekyll::SeoTag::Drop<a id="class-jekyll-seotag-drop"></a>
|
|
2
|
+
| | |
|
|
3
|
+
| --- | --- |
|
|
4
|
+
| **Inherits** | Jekyll::Drops::Drop |
|
|
5
|
+
| **Includes** | [Jekyll::SeoTag::UrlHelper](UrlHelper.md) |
|
|
6
|
+
| **Defined in** | lib/jekyll-seo-tag/drop.rb |
|
|
3
7
|
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
<a id="FORMAT_STRING_METHODS"></a>
|
|
7
|
-
#### `FORMAT_STRING_METHODS`
|
|
8
|
+
## Constants
|
|
9
|
+
### `FORMAT_STRING_METHODS`<a id="FORMAT_STRING_METHODS"></a>
|
|
8
10
|
Not documented.
|
|
9
11
|
|
|
10
|
-
|
|
11
|
-
#### `HOMEPAGE_OR_ABOUT_REGEX`
|
|
12
|
+
### `HOMEPAGE_OR_ABOUT_REGEX`<a id="HOMEPAGE_OR_ABOUT_REGEX"></a>
|
|
12
13
|
Not documented.
|
|
13
14
|
|
|
14
|
-
|
|
15
|
-
#### `TITLE_SEPARATOR`
|
|
15
|
+
### `TITLE_SEPARATOR`<a id="TITLE_SEPARATOR"></a>
|
|
16
16
|
Not documented.
|
|
17
17
|
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
<a id="method-c-new"></a>
|
|
21
|
-
#### `new(text, context)`
|
|
18
|
+
## Public Class Methods
|
|
19
|
+
### `new(text, context)`<a id="method-c-new"></a>
|
|
22
20
|
Not documented.
|
|
23
21
|
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
<a id="method-i-author"></a>
|
|
27
|
-
#### `author()`
|
|
22
|
+
## Public Instance Methods
|
|
23
|
+
### `author()`<a id="method-i-author"></a>
|
|
28
24
|
A drop representing the page author
|
|
29
|
-
|
|
30
|
-
<a id="method-i-canonical_url"></a>
|
|
31
|
-
#### `canonical_url()`
|
|
25
|
+
### `canonical_url()`<a id="method-i-canonical_url"></a>
|
|
32
26
|
Not documented.
|
|
33
|
-
|
|
34
|
-
<a id="method-i-date_modified"></a>
|
|
35
|
-
#### `date_modified()`
|
|
27
|
+
### `date_modified()`<a id="method-i-date_modified"></a>
|
|
36
28
|
Not documented.
|
|
37
|
-
|
|
38
|
-
<a id="method-i-date_published"></a>
|
|
39
|
-
#### `date_published()`
|
|
29
|
+
### `date_published()`<a id="method-i-date_published"></a>
|
|
40
30
|
Not documented.
|
|
41
|
-
|
|
42
|
-
<a id="method-i-description"></a>
|
|
43
|
-
#### `description()`
|
|
31
|
+
### `description()`<a id="method-i-description"></a>
|
|
44
32
|
Not documented.
|
|
45
|
-
|
|
46
|
-
<a id="method-i-image"></a>
|
|
47
|
-
#### `image()`
|
|
33
|
+
### `image()`<a id="method-i-image"></a>
|
|
48
34
|
Returns a [`Drop`](Drop.md) representing the page’s image Returns nil if the image has no path, to preserve backwards compatability
|
|
49
|
-
|
|
50
|
-
<a id="method-i-json_ld"></a>
|
|
51
|
-
#### `json_ld()`
|
|
35
|
+
### `json_ld()`<a id="method-i-json_ld"></a>
|
|
52
36
|
A drop representing the JSON-LD output
|
|
53
|
-
|
|
54
|
-
<a id="method-i-links"></a>
|
|
55
|
-
#### `links()`
|
|
37
|
+
### `links()`<a id="method-i-links"></a>
|
|
56
38
|
Not documented.
|
|
57
|
-
|
|
58
|
-
<a id="method-i-logo"></a>
|
|
59
|
-
#### `logo()`
|
|
39
|
+
### `logo()`<a id="method-i-logo"></a>
|
|
60
40
|
Not documented.
|
|
61
|
-
|
|
62
|
-
<a id="method-i-name"></a>
|
|
63
|
-
#### `name()`
|
|
41
|
+
### `name()`<a id="method-i-name"></a>
|
|
64
42
|
rubocop:enable Metrics/CyclomaticComplexity
|
|
65
|
-
|
|
66
|
-
<a id="method-i-page_lang"></a>
|
|
67
|
-
#### `page_lang()`
|
|
43
|
+
### `page_lang()`<a id="method-i-page_lang"></a>
|
|
68
44
|
Not documented.
|
|
69
|
-
|
|
70
|
-
<a id="method-i-page_locale"></a>
|
|
71
|
-
#### `page_locale()`
|
|
45
|
+
### `page_locale()`<a id="method-i-page_locale"></a>
|
|
72
46
|
Not documented.
|
|
73
|
-
|
|
74
|
-
<a id="method-i-page_title"></a>
|
|
75
|
-
#### `page_title()`
|
|
47
|
+
### `page_title()`<a id="method-i-page_title"></a>
|
|
76
48
|
Page title without site title or description appended
|
|
77
|
-
|
|
78
|
-
<a id="method-i-site_description"></a>
|
|
79
|
-
#### `site_description()`
|
|
49
|
+
### `site_description()`<a id="method-i-site_description"></a>
|
|
80
50
|
Not documented.
|
|
81
|
-
|
|
82
|
-
<a id="method-i-site_tagline"></a>
|
|
83
|
-
#### `site_tagline()`
|
|
51
|
+
### `site_tagline()`<a id="method-i-site_tagline"></a>
|
|
84
52
|
Not documented.
|
|
85
|
-
|
|
86
|
-
<a id="method-i-site_tagline_or_description"></a>
|
|
87
|
-
#### `site_tagline_or_description()`
|
|
53
|
+
### `site_tagline_or_description()`<a id="method-i-site_tagline_or_description"></a>
|
|
88
54
|
Not documented.
|
|
89
|
-
|
|
90
|
-
<a id="method-i-site_title"></a>
|
|
91
|
-
#### `site_title()`
|
|
55
|
+
### `site_title()`<a id="method-i-site_title"></a>
|
|
92
56
|
Not documented.
|
|
93
|
-
|
|
94
|
-
<a id="method-i-title"></a>
|
|
95
|
-
#### `title()`
|
|
57
|
+
### `title()`<a id="method-i-title"></a>
|
|
96
58
|
Page title with site title or description appended rubocop:disable Metrics/CyclomaticComplexity
|
|
97
|
-
|
|
98
|
-
<a id="method-i-title-3F"></a>
|
|
99
|
-
#### `title?()`
|
|
59
|
+
### `title?()`<a id="method-i-title-3F"></a>
|
|
100
60
|
Should the ‘\<title\>` tag be generated for this page?
|
|
101
|
-
|
|
102
|
-
<a id="method-i-type"></a>
|
|
103
|
-
#### `type()`
|
|
61
|
+
### `type()`<a id="method-i-type"></a>
|
|
104
62
|
Not documented.
|
|
105
|
-
|
|
106
|
-
<a id="method-i-version"></a>
|
|
107
|
-
#### `version()`
|
|
63
|
+
### `version()`<a id="method-i-version"></a>
|
|
108
64
|
Not documented.
|
|
@@ -1,8 +1,10 @@
|
|
|
1
|
-
<a id="class-jekyll-seotag-filters"></a>
|
|
2
|
-
|
|
1
|
+
# Class Jekyll::SeoTag::Filters<a id="class-jekyll-seotag-filters"></a>
|
|
2
|
+
| | |
|
|
3
|
+
| --- | --- |
|
|
4
|
+
| **Inherits** | Object |
|
|
5
|
+
| **Includes** | Jekyll::Filters, Liquid::StandardFilters |
|
|
6
|
+
| **Defined in** | lib/jekyll-seo-tag/filters.rb |
|
|
3
7
|
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
<a id="method-c-new"></a>
|
|
7
|
-
#### `new(context)`
|
|
8
|
+
## Public Class Methods
|
|
9
|
+
### `new(context)`<a id="method-c-new"></a>
|
|
8
10
|
Not documented.
|
|
@@ -1,5 +1,10 @@
|
|
|
1
|
-
<a id="class-jekyll-seotag-imagedrop"></a>
|
|
2
|
-
|
|
1
|
+
# Class Jekyll::SeoTag::ImageDrop<a id="class-jekyll-seotag-imagedrop"></a>
|
|
2
|
+
| | |
|
|
3
|
+
| --- | --- |
|
|
4
|
+
| **Inherits** | Jekyll::Drops::Drop |
|
|
5
|
+
| **Includes** | [Jekyll::SeoTag::UrlHelper](UrlHelper.md) |
|
|
6
|
+
| **Defined in** | lib/jekyll-seo-tag/image_drop.rb |
|
|
7
|
+
|
|
3
8
|
A drop representing the page image The image path will be pulled from:
|
|
4
9
|
|
|
5
10
|
1. The `image` key if it’s a string
|
|
@@ -10,20 +15,14 @@ A drop representing the page image The image path will be pulled from:
|
|
|
10
15
|
|
|
11
16
|
4. The `image.twitter` key
|
|
12
17
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
<a id="method-c-new"></a>
|
|
16
|
-
#### `new(page: nil, context: nil)`
|
|
18
|
+
## Public Class Methods
|
|
19
|
+
### `new(page: nil, context: nil)`<a id="method-c-new"></a>
|
|
17
20
|
Initialize a new [`ImageDrop`](ImageDrop.md)
|
|
18
21
|
|
|
19
22
|
page - The page hash (e.g., Page#to\_liquid) context - the Liquid::Context
|
|
20
23
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
<a id="method-i-path"></a>
|
|
24
|
-
#### `path()`
|
|
24
|
+
## Public Instance Methods
|
|
25
|
+
### `path()`<a id="method-i-path"></a>
|
|
25
26
|
Called path for backwards compatability, this is really the escaped, absolute URL representing the page’s image Returns nil if no image path can be determined
|
|
26
|
-
|
|
27
|
-
<a id="method-i-to_s"></a>
|
|
28
|
-
#### `to_s()`
|
|
27
|
+
### `to_s()`<a id="method-i-to_s"></a>
|
|
29
28
|
Alias for: [`path`](#method-i-path)
|
|
@@ -1,15 +1,14 @@
|
|
|
1
|
-
<a id="module-jekyll-seotag-jsonld"></a>
|
|
2
|
-
|
|
3
|
-
|
|
1
|
+
# Module Jekyll::SeoTag::JSONLD<a id="module-jekyll-seotag-jsonld"></a>
|
|
2
|
+
| | |
|
|
3
|
+
| --- | --- |
|
|
4
|
+
| **Defined in** | lib/jekyll-seo-tag/json_ld.rb |
|
|
4
5
|
|
|
5
|
-
|
|
6
|
+
This module is deprecated, but is included in the Gem to avoid a breaking change and should be removed at the next major version bump
|
|
6
7
|
|
|
7
|
-
|
|
8
|
-
|
|
8
|
+
## Constants
|
|
9
|
+
### `METHODS_KEYS`<a id="METHODS_KEYS"></a>
|
|
9
10
|
Not documented.
|
|
10
11
|
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
<a id="method-i-json_ld"></a>
|
|
14
|
-
#### `json_ld()`
|
|
12
|
+
## Public Instance Methods
|
|
13
|
+
### `json_ld()`<a id="method-i-json_ld"></a>
|
|
15
14
|
Self should be a [`Jekyll::SeoTag::Drop`](Drop.md) instance (when extending the module)
|
|
@@ -1,34 +1,23 @@
|
|
|
1
|
-
<a id="class-jekyll-seotag-jsonlddrop"></a>
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
1
|
+
# Class Jekyll::SeoTag::JSONLDDrop<a id="class-jekyll-seotag-jsonlddrop"></a>
|
|
2
|
+
| | |
|
|
3
|
+
| --- | --- |
|
|
4
|
+
| **Inherits** | Jekyll::Drops::Drop |
|
|
5
|
+
| **Defined in** | lib/jekyll-seo-tag/json_ld_drop.rb |
|
|
6
|
+
|
|
7
|
+
## Public Class Methods
|
|
8
|
+
### `new(page_drop)`<a id="method-c-new"></a>
|
|
8
9
|
page\_drop should be an instance of [`Jekyll::SeoTag::Drop`](Drop.md)
|
|
9
10
|
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
<a id="method-i-author"></a>
|
|
13
|
-
#### `author()`
|
|
11
|
+
## Public Instance Methods
|
|
12
|
+
### `author()`<a id="method-i-author"></a>
|
|
14
13
|
Not documented.
|
|
15
|
-
|
|
16
|
-
<a id="method-i-fallback_data"></a>
|
|
17
|
-
#### `fallback_data()`
|
|
14
|
+
### `fallback_data()`<a id="method-i-fallback_data"></a>
|
|
18
15
|
Not documented.
|
|
19
|
-
|
|
20
|
-
<a id="method-i-image"></a>
|
|
21
|
-
#### `image()`
|
|
16
|
+
### `image()`<a id="method-i-image"></a>
|
|
22
17
|
Not documented.
|
|
23
|
-
|
|
24
|
-
<a id="method-i-mainEntityOfPage"></a>
|
|
25
|
-
#### `mainEntityOfPage()`
|
|
18
|
+
### `mainEntityOfPage()`<a id="method-i-mainEntityOfPage"></a>
|
|
26
19
|
Alias for: [`main_entity`](#method-i-main_entity)
|
|
27
|
-
|
|
28
|
-
<a id="method-i-publisher"></a>
|
|
29
|
-
#### `publisher()`
|
|
20
|
+
### `publisher()`<a id="method-i-publisher"></a>
|
|
30
21
|
Not documented.
|
|
31
|
-
|
|
32
|
-
<a id="method-i-to_json"></a>
|
|
33
|
-
#### `to_json(state = nil)`
|
|
22
|
+
### `to_json(state = nil)`<a id="method-i-to_json"></a>
|
|
34
23
|
Returns a JSON-encoded object containing the JSON-LD data. Keys are sorted.
|
|
@@ -1,4 +1,7 @@
|
|
|
1
|
-
<a id="module-jekyll-seotag-urlhelper"></a>
|
|
2
|
-
|
|
1
|
+
# Module Jekyll::SeoTag::UrlHelper<a id="module-jekyll-seotag-urlhelper"></a>
|
|
2
|
+
| | |
|
|
3
|
+
| --- | --- |
|
|
4
|
+
| **Defined in** | lib/jekyll-seo-tag/url_helper.rb |
|
|
5
|
+
|
|
3
6
|
Mixin to share common URL-related methods between class
|
|
4
7
|
|
|
@@ -1,10 +1,11 @@
|
|
|
1
|
-
<a id="class-jekyll-seotag"></a>
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
1
|
+
# Class Jekyll::SeoTag<a id="class-jekyll-seotag"></a>
|
|
2
|
+
| | |
|
|
3
|
+
| --- | --- |
|
|
4
|
+
| **Inherits** | [Liquid::Tag](../Liquid/Tag.md) |
|
|
5
|
+
| **Defined in** | lib/jekyll-seo-tag.rb, lib/jekyll-seo-tag/author_drop.rb, lib/jekyll-seo-tag/drop.rb, lib/jekyll-seo-tag/filters.rb, lib/jekyll-seo-tag/image_drop.rb, lib/jekyll-seo-tag/json_ld.rb, lib/jekyll-seo-tag/json_ld_drop.rb, lib/jekyll-seo-tag/url_helper.rb, lib/jekyll-seo-tag/version.rb |
|
|
6
|
+
|
|
7
|
+
## Constants
|
|
8
|
+
### `MINIFY_REGEX`<a id="MINIFY_REGEX"></a>
|
|
8
9
|
Matches all whitespace that follows either
|
|
9
10
|
|
|
10
11
|
```
|
|
@@ -21,28 +22,19 @@ so that we do not interfere with the HTML comment at the
|
|
|
21
22
|
very begining
|
|
22
23
|
```
|
|
23
24
|
|
|
24
|
-
|
|
25
|
-
#### `VERSION`
|
|
25
|
+
### `VERSION`<a id="VERSION"></a>
|
|
26
26
|
Not documented.
|
|
27
27
|
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
<a id="attribute-i-context"></a>
|
|
31
|
-
#### `context` [RW]
|
|
28
|
+
## Attributes
|
|
29
|
+
### `context` [RW]<a id="attribute-i-context"></a>
|
|
32
30
|
Not documented.
|
|
33
31
|
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
<a id="method-c-new"></a>
|
|
37
|
-
#### `new(_tag_name, text, _tokens)`
|
|
32
|
+
## Public Class Methods
|
|
33
|
+
### `new(_tag_name, text, _tokens)`<a id="method-c-new"></a>
|
|
38
34
|
Not documented.
|
|
39
|
-
|
|
40
|
-
<a id="method-c-template"></a>
|
|
41
|
-
#### `template()`
|
|
35
|
+
### `template()`<a id="method-c-template"></a>
|
|
42
36
|
Not documented.
|
|
43
37
|
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
<a id="method-i-render"></a>
|
|
47
|
-
#### `render(context)`
|
|
38
|
+
## Public Instance Methods
|
|
39
|
+
### `render(context)`<a id="method-i-render"></a>
|
|
48
40
|
Not documented.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
-
<a id="module-jekyll"></a>
|
|
2
|
-
|
|
1
|
+
# Module Jekyll<a id="module-jekyll"></a>
|
|
2
|
+
| | |
|
|
3
|
+
| --- | --- |
|
|
4
|
+
| **Defined in** | lib/jekyll-seo-tag.rb, lib/jekyll-seo-tag/author_drop.rb, lib/jekyll-seo-tag/drop.rb, lib/jekyll-seo-tag/filters.rb, lib/jekyll-seo-tag/image_drop.rb, lib/jekyll-seo-tag/json_ld.rb, lib/jekyll-seo-tag/json_ld_drop.rb, lib/jekyll-seo-tag/url_helper.rb, lib/jekyll-seo-tag/version.rb |
|
|
3
5
|
|
|
@@ -587,10 +587,11 @@ class RDoc::Generator::Markdown
|
|
|
587
587
|
#
|
|
588
588
|
# @param method [RDoc::AnyMethod] Method object to render.
|
|
589
589
|
# @param current_class [RDoc::Context] Class or module currently being rendered.
|
|
590
|
+
# @param heading_level_offset [Integer] Heading levels to add while rendering.
|
|
590
591
|
#
|
|
591
592
|
# @return [String] Rendered method description.
|
|
592
|
-
def method_description(method, current_class:)
|
|
593
|
-
text = describe(method, heading_level_offset:
|
|
593
|
+
def method_description(method, current_class:, heading_level_offset:)
|
|
594
|
+
text = describe(method, heading_level_offset: heading_level_offset)
|
|
594
595
|
return text unless text.empty?
|
|
595
596
|
|
|
596
597
|
aliased_method = method.is_alias_for
|
|
@@ -25,30 +25,33 @@
|
|
|
25
25
|
<%- end -%>
|
|
26
26
|
<% klass.each_section do |section, constants, attributes| -%>
|
|
27
27
|
<%- section_title = section.title.to_s.strip -%>
|
|
28
|
+
<%- section_heading_level = section_title.empty? ? 1 : 2 -%>
|
|
29
|
+
<%- group_heading_level = section_heading_level + 1 -%>
|
|
30
|
+
<%- member_heading_level = group_heading_level + 1 -%>
|
|
28
31
|
<%- unless section_title.empty? -%>
|
|
29
|
-
|
|
32
|
+
<%= "#" * section_heading_level %> <%= section_title %>
|
|
30
33
|
<%- end -%>
|
|
31
|
-
<%- section_description = section_description(section, heading_level_offset:
|
|
34
|
+
<%- section_description = section_description(section, heading_level_offset: section_heading_level) -%>
|
|
32
35
|
<%- unless section_description.empty? -%>
|
|
33
36
|
|
|
34
37
|
<%= section_description %>
|
|
35
38
|
<%- end -%>
|
|
36
39
|
<%- unless constants.empty? -%>
|
|
37
40
|
|
|
38
|
-
|
|
41
|
+
<%= "#" * group_heading_level %> Constants
|
|
39
42
|
<% constants.sort_by(&:name).each do |const| -%>
|
|
40
43
|
|
|
41
|
-
|
|
42
|
-
<%= describe(const, fallback: "Not documented.", heading_level_offset:
|
|
44
|
+
<%= "#" * member_heading_level %> `<%= const.name %>`<%= anchor(const.name) %>
|
|
45
|
+
<%= describe(const, fallback: "Not documented.", heading_level_offset: member_heading_level) %>
|
|
43
46
|
<% end -%>
|
|
44
47
|
<%- end -%>
|
|
45
48
|
<%- unless attributes.empty? -%>
|
|
46
49
|
|
|
47
|
-
|
|
50
|
+
<%= "#" * group_heading_level %> Attributes
|
|
48
51
|
<% attributes.sort_by(&:name).each do |attr| -%>
|
|
49
52
|
|
|
50
|
-
|
|
51
|
-
<%= describe(attr, fallback: "Not documented.", heading_level_offset:
|
|
53
|
+
<%= "#" * member_heading_level %> `<%= attr.name %>` [<%= attr.rw %>]<%= anchor(attr.aref.strip) %>
|
|
54
|
+
<%= describe(attr, fallback: "Not documented.", heading_level_offset: member_heading_level) %>
|
|
52
55
|
<% end -%>
|
|
53
56
|
<%- end -%>
|
|
54
57
|
<% klass.methods_by_type(section).each do |type, visibilities| -%>
|
|
@@ -56,10 +59,10 @@
|
|
|
56
59
|
<% methods = methods.select(&:display?) -%>
|
|
57
60
|
<% next if methods.empty? -%>
|
|
58
61
|
|
|
59
|
-
|
|
62
|
+
<%= "#" * group_heading_level %> <%= visibility.capitalize %> <%= type.capitalize %> Methods
|
|
60
63
|
<% methods.each do |method| -%>
|
|
61
|
-
|
|
62
|
-
<%= method_description(method, current_class: klass) %>
|
|
64
|
+
<%= "#" * member_heading_level %> `<%= method.name %><%= method_signature(method) %>`<%= anchor(method.aref) %>
|
|
65
|
+
<%= method_description(method, current_class: klass, heading_level_offset: member_heading_level) %>
|
|
63
66
|
<% end -%>
|
|
64
67
|
<% end -%>
|
|
65
68
|
<% end -%>
|