Skip to content

Commit ea52f34

Browse files
Updated documentation to add JsonLines format and improved descriptions
1 parent 7d76778 commit ea52f34

File tree

6 files changed

+22
-16
lines changed

6 files changed

+22
-16
lines changed

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "dragon-code/laravel-feeds",
3-
"description": "Simple generation XML feeds",
3+
"description": "Fast export of large datasets to feeds for marketplaces and services",
44
"license": "MIT",
55
"type": "library",
66
"authors": [

docs/labels.list

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,8 @@
1111
Available for JSON feeds
1212
</secondary-label>
1313

14+
<secondary-label id="format-jsonl" name="jsonl" color="tangerine">
15+
Available for JSON Lines feeds
16+
</secondary-label>
17+
1418
</labels>

docs/laravel-feeds.tree

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@
1212
<toc-element toc-title="License" topic="license.topic" />
1313
</toc-element>
1414
<toc-element topic="introduction.topic">
15-
<toc-element topic="supported-formats.topic" />
1615
<toc-element topic="installation.topic" />
1716
<toc-element topic="create-feeds.topic" />
1817
<toc-element topic="generation.topic">
1918
</toc-element>
2019
<toc-element topic="advanced-usage.topic" />
20+
<toc-element topic="supported-formats.topic" />
2121
</toc-element>
2222
<toc-element toc-title="Receipts">
2323
<toc-element topic="receipt-sitemap.topic" />

docs/topics/advanced-usage.topic

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@
6262
<chapter title="Information" id="information">
6363
<secondary-label ref="format-xml" />
6464
<secondary-label ref="format-json" />
65+
<secondary-label ref="format-jsonl" />
6566

6667
<p>
6768
To add information to the beginning of the root element (if present) or without it,

docs/topics/create-feeds.topic

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -101,10 +101,6 @@
101101
</chapter>
102102

103103
<chapter title="File format" id="file_format">
104-
<note title="Supported formats">
105-
<include from="supported-formats.topic" element-id="formats" />
106-
</note>
107-
108104
<p>
109105
You can generate feeds in different formats.
110106
A feed class can be correctly exported only to the format for which it is intended.
@@ -117,7 +113,6 @@
117113
</p>
118114

119115
<code-block lang="php" src="create-feeds-feed-format.php" include-lines="5-" />
120-
121116
</chapter>
122117

123118
</topic>

docs/topics/supported-formats.topic

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,20 @@
1212

1313
<show-structure depth="3" />
1414

15-
<snippet id="formats">
16-
<list>
17-
<li>xml</li>
18-
<li>json</li>
19-
</list>
15+
<deflist type="compact">
16+
<def title="xml">
17+
Generates feeds in XML format.
18+
</def>
19+
<def title="json">
20+
Generates feeds in JSON format.
21+
</def>
22+
<def title="jsonl">
23+
Generates feeds in JSON Lines format.
24+
</def>
25+
</deflist>
26+
27+
<p>
28+
By default, the <code>xml</code> format is used.
29+
</p>
2030

21-
<p>
22-
By default, the <code>xml</code> format is used.
23-
</p>
24-
</snippet>
2531
</topic>

0 commit comments

Comments
 (0)