Skip to content

Commit 82b1148

Browse files
semantic-release-botsemantic-release-bot
committed
chore(release): 1.12.0 [skip ci]
# [1.12.0](v1.11.0...v1.12.0) (2020-10-30) ### Features * added optional title prop ([0b844bf](0b844bf))
1 parent 0520286 commit 82b1148

5 files changed

+26
-10
lines changed

‎CHANGELOG.md

+7
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
# [1.12.0](https://github.com/dbartholomae/jsx-readme/compare/v1.11.0...v1.12.0) (2020-10-30)
2+
3+
4+
### Features
5+
6+
* added optional title prop ([0b844bf](https://github.com/dbartholomae/jsx-readme/commit/0b844bf3c77c0f9226a168d1c75afd2dbf22dcba))
7+
18
# [1.11.0](https://github.com/dbartholomae/jsx-readme/compare/v1.10.0...v1.11.0) (2020-10-18)
29

310

‎docs/modules/_components_contributingsection_.html

+5-2
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ <h2>Functions</h2>
8585
<a name="contributingsection" class="tsd-anchor"></a>
8686
<h3><span class="tsd-flag ts-flagConst">Const</span> Contributing<wbr>Section</h3>
8787
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
88-
<li class="tsd-signature tsd-kind-icon">Contributing<wbr>Section<span class="tsd-signature-symbol">(</span>props<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>contributingFilePath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Element</span></li>
88+
<li class="tsd-signature tsd-kind-icon">Contributing<wbr>Section<span class="tsd-signature-symbol">(</span>props<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>contributingFilePath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Element</span></li>
8989
</ul>
9090
<ul class="tsd-descriptions">
9191
<li class="tsd-description">
@@ -102,11 +102,14 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> Contributing<wbr>Section</h
102102
<h4 class="tsd-parameters-title">Parameters</h4>
103103
<ul class="tsd-parameters">
104104
<li>
105-
<h5>props: <span class="tsd-signature-symbol">{ </span>contributingFilePath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
105+
<h5>props: <span class="tsd-signature-symbol">{ </span>contributingFilePath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
106106
<ul class="tsd-parameters">
107107
<li class="tsd-parameter">
108108
<h5>contributing<wbr>File<wbr>Path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
109109
</li>
110+
<li class="tsd-parameter">
111+
<h5>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
112+
</li>
110113
</ul>
111114
</li>
112115
</ul>

‎docs/modules/_components_examplesfrompkg_.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -84,10 +84,10 @@ <h2>Variables</h2>
8484
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
8585
<a name="examplesfrompkg" class="tsd-anchor"></a>
8686
<h3><span class="tsd-flag ts-flagConst">Const</span> Examples<wbr>From<wbr>Pkg</h3>
87-
<div class="tsd-signature tsd-kind-icon">Examples<wbr>From<wbr>Pkg<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Component</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Props</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = awaitComponent(async ({pkg,/** The encoding to use for loading all files. */encoding &#x3D; &quot;utf8&quot;,/** Whether to replace all imports from &#x27;..&#x27; with imports from &#x27;package-name&#x27; */replacePackageImportsWithPackageName &#x3D; true,}) &#x3D;&gt; {const examplesFolder &#x3D; pkg.directories?.example;if (examplesFolder &#x3D;&#x3D;&#x3D; undefined) {return null;}const filenames &#x3D; await fs.readdir(examplesFolder);const examples &#x3D; await Promise.all(filenames.map(async (fileName) &#x3D;&gt; ({fileName,content: await fs.readFile(path.join(examplesFolder, fileName), {encoding,}),})));const replacements &#x3D; replacePackageImportsWithPackageName? [{find: /from &quot;..&quot;/g,replace: &#x60;from &quot;${pkg.name}&quot;&#x60;,},]: [];return (&lt;Fragment&gt;&lt;Heading level&#x3D;{2}&gt;🔬 Examples&lt;/Heading&gt;{examples.sort(({ fileName: fileNameA }, { fileName: fileNameB }) &#x3D;&gt;fileNameA.localeCompare(fileNameB, &quot;en&quot;, { sensitivity: &quot;base&quot; })).map(({ fileName, content }) &#x3D;&gt; (&lt;CodeFilekey&#x3D;{fileName}fileName&#x3D;{fileName}replacements&#x3D;{replacements}&gt;{content}&lt;/CodeFile&gt;))}&lt;/Fragment&gt;);})</span></div>
87+
<div class="tsd-signature tsd-kind-icon">Examples<wbr>From<wbr>Pkg<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Component</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Props</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = awaitComponent(async ({pkg,/** The encoding to use for loading all files. */encoding &#x3D; &quot;utf8&quot;,/** Whether to replace all imports from &#x27;..&#x27; with imports from &#x27;package-name&#x27; */replacePackageImportsWithPackageName &#x3D; true,title &#x3D; &quot;🔬 Examples&quot;,}) &#x3D;&gt; {const examplesFolder &#x3D; pkg.directories?.example;if (examplesFolder &#x3D;&#x3D;&#x3D; undefined) {return null;}const filenames &#x3D; await fs.readdir(examplesFolder);const examples &#x3D; await Promise.all(filenames.map(async (fileName) &#x3D;&gt; ({fileName,content: await fs.readFile(path.join(examplesFolder, fileName), {encoding,}),})));const replacements &#x3D; replacePackageImportsWithPackageName? [{find: /from &quot;..&quot;/g,replace: &#x60;from &quot;${pkg.name}&quot;&#x60;,},]: [];return (&lt;Fragment&gt;&lt;Heading level&#x3D;{2}&gt;{title}&lt;/Heading&gt;{examples.sort(({ fileName: fileNameA }, { fileName: fileNameB }) &#x3D;&gt;fileNameA.localeCompare(fileNameB, &quot;en&quot;, { sensitivity: &quot;base&quot; })).map(({ fileName, content }) &#x3D;&gt; (&lt;CodeFilekey&#x3D;{fileName}fileName&#x3D;{fileName}replacements&#x3D;{replacements}&gt;{content}&lt;/CodeFile&gt;))}&lt;/Fragment&gt;);})</span></div>
8888
<aside class="tsd-sources">
8989
<ul>
90-
<li>Defined in <a href="https://github.com/dbartholomae/jsx-readme/blob/main/src/components/ExamplesFromPkg.tsx#L17">components/ExamplesFromPkg.tsx:17</a></li>
90+
<li>Defined in <a href="https://github.com/dbartholomae/jsx-readme/blob/main/src/components/ExamplesFromPkg.tsx#L18">components/ExamplesFromPkg.tsx:18</a></li>
9191
</ul>
9292
</aside>
9393
<div class="tsd-comment tsd-typography">

‎docs/modules/_components_homepagefrompkg_.html

+6-3
Original file line numberDiff line numberDiff line change
@@ -85,13 +85,13 @@ <h2>Functions</h2>
8585
<a name="homepagefrompkg" class="tsd-anchor"></a>
8686
<h3><span class="tsd-flag ts-flagConst">Const</span> Homepage<wbr>From<wbr>Pkg</h3>
8787
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
88-
<li class="tsd-signature tsd-kind-icon">Homepage<wbr>From<wbr>Pkg<span class="tsd-signature-symbol">(</span>props<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>pkg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>homepage<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Element</span></li>
88+
<li class="tsd-signature tsd-kind-icon">Homepage<wbr>From<wbr>Pkg<span class="tsd-signature-symbol">(</span>props<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>pkg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>homepage<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Element</span></li>
8989
</ul>
9090
<ul class="tsd-descriptions">
9191
<li class="tsd-description">
9292
<aside class="tsd-sources">
9393
<ul>
94-
<li>Defined in <a href="https://github.com/dbartholomae/jsx-readme/blob/main/src/components/HomepageFromPkg.tsx#L12">components/HomepageFromPkg.tsx:12</a></li>
94+
<li>Defined in <a href="https://github.com/dbartholomae/jsx-readme/blob/main/src/components/HomepageFromPkg.tsx#L13">components/HomepageFromPkg.tsx:13</a></li>
9595
</ul>
9696
</aside>
9797
<div class="tsd-comment tsd-typography">
@@ -102,7 +102,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> Homepage<wbr>From<wbr>Pkg</
102102
<h4 class="tsd-parameters-title">Parameters</h4>
103103
<ul class="tsd-parameters">
104104
<li>
105-
<h5>props: <span class="tsd-signature-symbol">{ </span>pkg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>homepage<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span></h5>
105+
<h5>props: <span class="tsd-signature-symbol">{ </span>pkg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>homepage<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
106106
<ul class="tsd-parameters">
107107
<li class="tsd-parameter">
108108
<h5>pkg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>homepage<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
@@ -112,6 +112,9 @@ <h5>homepage<span class="tsd-signature-symbol">: </span><span class="tsd-signatu
112112
</li>
113113
</ul>
114114
</li>
115+
<li class="tsd-parameter">
116+
<h5>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
117+
</li>
115118
</ul>
116119
</li>
117120
</ul>

‎docs/modules/_components_licensefrompkg_.html

+6-3
Original file line numberDiff line numberDiff line change
@@ -85,13 +85,13 @@ <h2>Functions</h2>
8585
<a name="licensefrompkg" class="tsd-anchor"></a>
8686
<h3><span class="tsd-flag ts-flagConst">Const</span> License<wbr>From<wbr>Pkg</h3>
8787
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
88-
<li class="tsd-signature tsd-kind-icon">License<wbr>From<wbr>Pkg<span class="tsd-signature-symbol">(</span>props<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>licenseFilePath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>pkg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>license<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Element</span></li>
88+
<li class="tsd-signature tsd-kind-icon">License<wbr>From<wbr>Pkg<span class="tsd-signature-symbol">(</span>props<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>licenseFilePath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>pkg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>license<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Element</span></li>
8989
</ul>
9090
<ul class="tsd-descriptions">
9191
<li class="tsd-description">
9292
<aside class="tsd-sources">
9393
<ul>
94-
<li>Defined in <a href="https://github.com/dbartholomae/jsx-readme/blob/main/src/components/LicenseFromPkg.tsx#L13">components/LicenseFromPkg.tsx:13</a></li>
94+
<li>Defined in <a href="https://github.com/dbartholomae/jsx-readme/blob/main/src/components/LicenseFromPkg.tsx#L14">components/LicenseFromPkg.tsx:14</a></li>
9595
</ul>
9696
</aside>
9797
<div class="tsd-comment tsd-typography">
@@ -102,7 +102,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> License<wbr>From<wbr>Pkg</h
102102
<h4 class="tsd-parameters-title">Parameters</h4>
103103
<ul class="tsd-parameters">
104104
<li>
105-
<h5>props: <span class="tsd-signature-symbol">{ </span>licenseFilePath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>pkg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>license<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span></h5>
105+
<h5>props: <span class="tsd-signature-symbol">{ </span>licenseFilePath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>pkg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>license<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
106106
<ul class="tsd-parameters">
107107
<li class="tsd-parameter">
108108
<h5>license<wbr>File<wbr>Path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
@@ -115,6 +115,9 @@ <h5>license<span class="tsd-signature-symbol">: </span><span class="tsd-signatur
115115
</li>
116116
</ul>
117117
</li>
118+
<li class="tsd-parameter">
119+
<h5>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
120+
</li>
118121
</ul>
119122
</li>
120123
</ul>

0 commit comments

Comments
 (0)