From b9d4dff574180cdab8dde09bf5c5c33280aafb31 Mon Sep 17 00:00:00 2001 From: semantic-release-bot Date: Fri, 8 Oct 2021 16:27:08 +0000 Subject: [PATCH] chore(release): 1.18.0 [skip ci] # [1.18.0](https://github.com/dbartholomae/jsx-readme/compare/v1.17.0...v1.18.0) (2021-10-08) ### Features * **FundingSectionFromPkg:** add component ([65cff9f](https://github.com/dbartholomae/jsx-readme/commit/65cff9f0e56fc313e31cdc716c1813952373a541)) * **FundingSectionFromPkg:** export component ([ff922dc](https://github.com/dbartholomae/jsx-readme/commit/ff922dcdde6e8b793af33a43b345b35a899bcb76)) --- CHANGELOG.md | 8 ++ docs/assets/js/search.js | 2 +- docs/index.html | 49 +++++---- docs/modules.html | 231 +++++++++++++++++++-------------------- 4 files changed, 151 insertions(+), 139 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c96814f..2b252aa 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,11 @@ +# [1.18.0](https://github.com/dbartholomae/jsx-readme/compare/v1.17.0...v1.18.0) (2021-10-08) + + +### Features + +* **FundingSectionFromPkg:** add component ([65cff9f](https://github.com/dbartholomae/jsx-readme/commit/65cff9f0e56fc313e31cdc716c1813952373a541)) +* **FundingSectionFromPkg:** export component ([ff922dc](https://github.com/dbartholomae/jsx-readme/commit/ff922dcdde6e8b793af33a43b345b35a899bcb76)) + # [1.17.0](https://github.com/dbartholomae/jsx-readme/compare/v1.16.0...v1.17.0) (2021-10-06) diff --git a/docs/assets/js/search.js b/docs/assets/js/search.js index 2eace70..e65894d 100644 --- a/docs/assets/js/search.js +++ b/docs/assets/js/search.js @@ -1 +1 @@ -window.searchData = {"kinds":{"64":"Function"},"rows":[{"id":0,"kind":64,"name":"Badge","url":"modules.html#Badge","classes":"tsd-kind-function"},{"id":1,"kind":64,"name":"ContributingSection","url":"modules.html#ContributingSection","classes":"tsd-kind-function"},{"id":2,"kind":64,"name":"ExamplesFromPkg","url":"modules.html#ExamplesFromPkg","classes":"tsd-kind-function"},{"id":3,"kind":64,"name":"LicenseFromPkg","url":"modules.html#LicenseFromPkg","classes":"tsd-kind-function"},{"id":4,"kind":64,"name":"DescriptionFromPkg","url":"modules.html#DescriptionFromPkg","classes":"tsd-kind-function"},{"id":5,"kind":64,"name":"JsxReadmeBadge","url":"modules.html#JsxReadmeBadge","classes":"tsd-kind-function"},{"id":6,"kind":64,"name":"NpmVersionBadge","url":"modules.html#NpmVersionBadge","classes":"tsd-kind-function"},{"id":7,"kind":64,"name":"GithubTopLanguageBadge","url":"modules.html#GithubTopLanguageBadge","classes":"tsd-kind-function"},{"id":8,"kind":64,"name":"CodecovBadge","url":"modules.html#CodecovBadge","classes":"tsd-kind-function"},{"id":9,"kind":64,"name":"SemanticReleaseBadge","url":"modules.html#SemanticReleaseBadge","classes":"tsd-kind-function"},{"id":10,"kind":64,"name":"DevDependenciesBadge","url":"modules.html#DevDependenciesBadge","classes":"tsd-kind-function"},{"id":11,"kind":64,"name":"DiscordBadge","url":"modules.html#DiscordBadge","classes":"tsd-kind-function"},{"id":12,"kind":64,"name":"CLAAssistantBadge","url":"modules.html#CLAAssistantBadge","classes":"tsd-kind-function"},{"id":13,"kind":64,"name":"HitsBadge","url":"modules.html#HitsBadge","classes":"tsd-kind-function"},{"id":14,"kind":64,"name":"renderToFile","url":"modules.html#renderToFile","classes":"tsd-kind-function"}],"index":{"version":"2.3.9","fields":["name","parent"],"fieldVectors":[["name/0",[0,23.671]],["parent/0",[]],["name/1",[1,23.671]],["parent/1",[]],["name/2",[2,23.671]],["parent/2",[]],["name/3",[3,23.671]],["parent/3",[]],["name/4",[4,23.671]],["parent/4",[]],["name/5",[5,23.671]],["parent/5",[]],["name/6",[6,23.671]],["parent/6",[]],["name/7",[7,23.671]],["parent/7",[]],["name/8",[8,23.671]],["parent/8",[]],["name/9",[9,23.671]],["parent/9",[]],["name/10",[10,23.671]],["parent/10",[]],["name/11",[11,23.671]],["parent/11",[]],["name/12",[12,23.671]],["parent/12",[]],["name/13",[13,23.671]],["parent/13",[]],["name/14",[14,23.671]],["parent/14",[]]],"invertedIndex":[["badge",{"_index":0,"name":{"0":{}},"parent":{}}],["claassistantbadge",{"_index":12,"name":{"12":{}},"parent":{}}],["codecovbadge",{"_index":8,"name":{"8":{}},"parent":{}}],["contributingsection",{"_index":1,"name":{"1":{}},"parent":{}}],["descriptionfrompkg",{"_index":4,"name":{"4":{}},"parent":{}}],["devdependenciesbadge",{"_index":10,"name":{"10":{}},"parent":{}}],["discordbadge",{"_index":11,"name":{"11":{}},"parent":{}}],["examplesfrompkg",{"_index":2,"name":{"2":{}},"parent":{}}],["githubtoplanguagebadge",{"_index":7,"name":{"7":{}},"parent":{}}],["hitsbadge",{"_index":13,"name":{"13":{}},"parent":{}}],["jsxreadmebadge",{"_index":5,"name":{"5":{}},"parent":{}}],["licensefrompkg",{"_index":3,"name":{"3":{}},"parent":{}}],["npmversionbadge",{"_index":6,"name":{"6":{}},"parent":{}}],["rendertofile",{"_index":14,"name":{"14":{}},"parent":{}}],["semanticreleasebadge",{"_index":9,"name":{"9":{}},"parent":{}}]],"pipeline":[]}} \ No newline at end of file +window.searchData = {"kinds":{"64":"Function"},"rows":[{"id":0,"kind":64,"name":"Badge","url":"modules.html#Badge","classes":"tsd-kind-function"},{"id":1,"kind":64,"name":"ContributingSection","url":"modules.html#ContributingSection","classes":"tsd-kind-function"},{"id":2,"kind":64,"name":"ExamplesFromPkg","url":"modules.html#ExamplesFromPkg","classes":"tsd-kind-function"},{"id":3,"kind":64,"name":"HomepageFromPkg","url":"modules.html#HomepageFromPkg","classes":"tsd-kind-function"},{"id":4,"kind":64,"name":"TitleFromPkg","url":"modules.html#TitleFromPkg","classes":"tsd-kind-function"},{"id":5,"kind":64,"name":"GithubIssuesBadge","url":"modules.html#GithubIssuesBadge","classes":"tsd-kind-function"},{"id":6,"kind":64,"name":"LicenseBadge","url":"modules.html#LicenseBadge","classes":"tsd-kind-function"},{"id":7,"kind":64,"name":"NpmDownloadsBadge","url":"modules.html#NpmDownloadsBadge","classes":"tsd-kind-function"},{"id":8,"kind":64,"name":"GithubWorkflowBadge","url":"modules.html#GithubWorkflowBadge","classes":"tsd-kind-function"},{"id":9,"kind":64,"name":"CoverallsBadge","url":"modules.html#CoverallsBadge","classes":"tsd-kind-function"},{"id":10,"kind":64,"name":"DependenciesBadge","url":"modules.html#DependenciesBadge","classes":"tsd-kind-function"},{"id":11,"kind":64,"name":"NpmBundleSizeBadge","url":"modules.html#NpmBundleSizeBadge","classes":"tsd-kind-function"},{"id":12,"kind":64,"name":"HacktoberfestBadge","url":"modules.html#HacktoberfestBadge","classes":"tsd-kind-function"},{"id":13,"kind":64,"name":"CircleCIBadge","url":"modules.html#CircleCIBadge","classes":"tsd-kind-function"},{"id":14,"kind":64,"name":"ContributorsSectionFromPkg","url":"modules.html#ContributorsSectionFromPkg","classes":"tsd-kind-function"}],"index":{"version":"2.3.9","fields":["name","parent"],"fieldVectors":[["name/0",[0,23.671]],["parent/0",[]],["name/1",[1,23.671]],["parent/1",[]],["name/2",[2,23.671]],["parent/2",[]],["name/3",[3,23.671]],["parent/3",[]],["name/4",[4,23.671]],["parent/4",[]],["name/5",[5,23.671]],["parent/5",[]],["name/6",[6,23.671]],["parent/6",[]],["name/7",[7,23.671]],["parent/7",[]],["name/8",[8,23.671]],["parent/8",[]],["name/9",[9,23.671]],["parent/9",[]],["name/10",[10,23.671]],["parent/10",[]],["name/11",[11,23.671]],["parent/11",[]],["name/12",[12,23.671]],["parent/12",[]],["name/13",[13,23.671]],["parent/13",[]],["name/14",[14,23.671]],["parent/14",[]]],"invertedIndex":[["badge",{"_index":0,"name":{"0":{}},"parent":{}}],["circlecibadge",{"_index":13,"name":{"13":{}},"parent":{}}],["contributingsection",{"_index":1,"name":{"1":{}},"parent":{}}],["contributorssectionfrompkg",{"_index":14,"name":{"14":{}},"parent":{}}],["coverallsbadge",{"_index":9,"name":{"9":{}},"parent":{}}],["dependenciesbadge",{"_index":10,"name":{"10":{}},"parent":{}}],["examplesfrompkg",{"_index":2,"name":{"2":{}},"parent":{}}],["githubissuesbadge",{"_index":5,"name":{"5":{}},"parent":{}}],["githubworkflowbadge",{"_index":8,"name":{"8":{}},"parent":{}}],["hacktoberfestbadge",{"_index":12,"name":{"12":{}},"parent":{}}],["homepagefrompkg",{"_index":3,"name":{"3":{}},"parent":{}}],["licensebadge",{"_index":6,"name":{"6":{}},"parent":{}}],["npmbundlesizebadge",{"_index":11,"name":{"11":{}},"parent":{}}],["npmdownloadsbadge",{"_index":7,"name":{"7":{}},"parent":{}}],["titlefrompkg",{"_index":4,"name":{"4":{}},"parent":{}}]],"pipeline":[]}} \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 1cee75f..b130628 100644 --- a/docs/index.html +++ b/docs/index.html @@ -76,7 +76,7 @@

jsx-readme

build status chat CLA Assistant - hacktoberfest badge

+ hacktoberfest badge

Generate Readme files with a React-like syntax and package.json-aware helpers.

🛠 Installation

@@ -92,7 +92,7 @@

🛠 Installation

"jsx": "react" } } - +

Create a README.MD template (you may copy the example from this repo examples/README.md.tsx and edit to your taste). Add the following script to your package.json:


@@ -101,7 +101,7 @@ 
🛠 Installation

     "generate:readme": "ts-node README.md.tsx"
   }
 }
-
+

🔬 Examples

@@ -136,9 +136,9 @@

package.json

], "author": "Daniel Bartholomae <daniel@bartholomae.name> (https://startup-cto.net)", "license": "MIT", - "homepage": "https://dbartholomae.github.io/jsx-readme", - "repository": "git@github.com:dbartholomae/jsx-readme.git", - "bugs": "https://github.com/dbartholomae/jsx-readme/issues", + "homepage": "https://dbartholomae.github.io/jsx-readme-test-fixture", + "repository": "git@github.com:dbartholomae/jsx-readme-test-fixture.git", + "bugs": "https://github.com/dbartholomae/jsx-readme-test-fixture/issues", "directories": { "lib": "lib", "doc": "docs", @@ -286,8 +286,15 @@

🖋️ Contributing

‍💼 Contributors

This package only works thanks to all of our contributors.

-
semantic-release-bot
semantic-release-bot		KwanJunWen
KwanJunWen		MDShields7
MDShields7		AJMcDee
AJMcDee		tancredosouza
tancredosouza		Ruchika30
Ruchika30
anshdhinhgra47
anshdhinhgra47		gedaiu
gedaiu		i-am-jeetu
i-am-jeetu		Pipo93
Pipo93		jruipinto
jruipinto
+
dbartholomae
dbartholomae		semantic-release-bot
semantic-release-bot		junwen-k
junwen-k		KwanJunWen
KwanJunWen		MDShields7
MDShields7		AJMcDee
AJMcDee
tancredosouza
tancredosouza		Ruchika30
Ruchika30		anshdhinhgra47
anshdhinhgra47		gedaiu
gedaiu		i-am-jeetu
i-am-jeetu		Pipo93
Pipo93

+ 3 contributors

+ +

🤝 Show your support

+ +

Give a ⭐ if this package helped you! You can also support the development of this package by funding.

+

📜 License

 @@ -308,22 +315,19 @@

📜 License

Badge
  • - CLAAssistantBadge -
    • -
  • - CodecovBadge + CircleCIBadge
  • ContributingSection
  • - DescriptionFromPkg + ContributorsSectionFromPkg
  • - DevDependenciesBadge + CoverallsBadge
  • - DiscordBadge + DependenciesBadge
  • ExamplesFromPkg @@ -332,25 +336,28 @@

    📜 License

    Fragment
  • - GithubTopLanguageBadge + GithubIssuesBadge +
    • +
  • + GithubWorkflowBadge
  • - HitsBadge + HacktoberfestBadge
  • - JsxReadmeBadge + HomepageFromPkg
  • - LicenseFromPkg + LicenseBadge
  • - NpmVersionBadge + NpmBundleSizeBadge
  • - SemanticReleaseBadge + NpmDownloadsBadge
  • - renderToFile + TitleFromPkg
    • diff --git a/docs/modules.html b/docs/modules.html index 5cfd65e..7d63303 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -73,21 +73,21 @@

    Index

    Functions

    @@ -139,49 +139,21 @@

    Returns null
    - -

    Const CLAAssistantBadge

    + +

    Const CircleCIBadge

      -
    • CLAAssistantBadge(props: Props): null | MdFragmentElement | MdAwaitElement | MdFunctionElement<unknown>
      • +
    • CircleCIBadge(props: Props): null | MdFragmentElement | MdAwaitElement | MdFunctionElement<unknown>
    -
    -
    - -

    Const CodecovBadge

    -
      -
    • CodecovBadge(props: Props): null | MdFragmentElement | MdAwaitElement | MdFunctionElement<unknown>
      • -
    -
    - -

    Const DescriptionFromPkg

    + +

    Const ContributorsSectionFromPkg

      -
    • DescriptionFromPkg(props: Props): null | MdFragmentElement | MdAwaitElement | MdFunctionElement<unknown>
      • +
    • ContributorsSectionFromPkg(props: Props): null | MdFragmentElement | MdAwaitElement | MdFunctionElement<unknown>
    - -

    Const DevDependenciesBadge

    + +

    Const CoverallsBadge

      -
    • DevDependenciesBadge(props: Readonly<BadgeProps>): null | MdFragmentElement | MdAwaitElement | MdFunctionElement<unknown>
      • +
    • CoverallsBadge(props: Props): null | MdFragmentElement | MdAwaitElement | MdFunctionElement<unknown>
    - -

    Const DiscordBadge

    + +

    Const DependenciesBadge

      -
    • DiscordBadge(props: Props): null | MdFragmentElement | MdAwaitElement | MdFunctionElement<unknown>
      • +
    • DependenciesBadge(props: Readonly<BadgeProps>): null | MdFragmentElement | MdAwaitElement | MdFunctionElement<unknown>
    - -

    Const GithubTopLanguageBadge

    + +

    Const GithubIssuesBadge

      -
    • GithubTopLanguageBadge(props: Readonly<BadgeProps>): null | MdFragmentElement | MdAwaitElement | MdFunctionElement<unknown>
      • +
    • GithubIssuesBadge(props: Readonly<BadgeProps>): null | MdFragmentElement | MdAwaitElement | MdFunctionElement<unknown>
    - -

    Const HitsBadge

    + +

    Const GithubWorkflowBadge

      -
    • HitsBadge(props: Readonly<BadgeProps>): null | MdFragmentElement | MdAwaitElement | MdFunctionElement<unknown>
      • +
    • GithubWorkflowBadge(props: Props): null | MdFragmentElement | MdAwaitElement | MdFunctionElement<unknown>
    • -

      Show a badge with the count of Hits(Page View Counter) on a particular Repo on GitHub

      +

      Display a badge with the status of a GitHub Workflow

      Parameters

      • -
        props: Readonly<BadgeProps>
        +
        props: Props

      Returns null | MdFragmentElement | MdAwaitElement | MdFunctionElement<unknown>

      @@ -433,27 +405,27 @@

      Returns null

    - -

    Const JsxReadmeBadge

    + +

    Const HacktoberfestBadge

      -
    • JsxReadmeBadge(props: unknown): null | MdFragmentElement | MdAwaitElement | MdFunctionElement<unknown>
      • +
    • HacktoberfestBadge(props: Props): null | MdFragmentElement | MdAwaitElement | MdFunctionElement<unknown>
    - -

    Const LicenseFromPkg

    + +

    Const HomepageFromPkg

      -
    • LicenseFromPkg(props: Readonly<Props>): null | MdFragmentElement | MdAwaitElement | MdFunctionElement<unknown>
      • +
    • HomepageFromPkg(props: Readonly<Props>): null | MdFragmentElement | MdAwaitElement | MdFunctionElement<unknown>
    - -

    Const NpmVersionBadge

    + +

    Const LicenseBadge

      -
    • NpmVersionBadge(props: Readonly<BadgeProps>): null | MdFragmentElement | MdAwaitElement | MdFunctionElement<unknown>
      • +
    • LicenseBadge(props: Props): null | MdFragmentElement | MdAwaitElement | MdFunctionElement<unknown>
    - -

    Const SemanticReleaseBadge

    + +

    Const NpmBundleSizeBadge

      -
    • SemanticReleaseBadge(props: Readonly<BadgeProps>): null | MdFragmentElement | MdAwaitElement | MdFunctionElement<unknown>
      • +
    • NpmBundleSizeBadge(props: Readonly<BadgeProps>): null | MdFragmentElement | MdAwaitElement | MdFunctionElement<unknown>
    - -

    renderToFile

    + +

    Const NpmDownloadsBadge

      -
    • renderToFile(path: string, element: MarkdownElement): Promise<void>
      • +
    • NpmDownloadsBadge(props: Readonly<BadgeProps>): null | MdFragmentElement | MdAwaitElement | MdFunctionElement<unknown>
    • -

      Renders a markdown element into file.

      +

      Display a badge with the weekly downloads on npm of this package.

      Parameters

      • -
        path: string
        +
        props: Readonly<BadgeProps>
        • +
      +

      Returns null | MdFragmentElement | MdAwaitElement | MdFunctionElement<unknown>

      +
      • +
    +
    +
    + +

    Const TitleFromPkg

    +
      +
    • TitleFromPkg(props: Props): null | MdFragmentElement | MdAwaitElement | MdFunctionElement<unknown>
      • +
    +
      +
    • + +
      +
      +

      Display a heading with the package name

      +
      +
      +

      Parameters

      +
      • -
        element: MarkdownElement
        +
        props: Props
      -

      Returns Promise<void>

      +

      Returns null | MdFragmentElement | MdAwaitElement | MdFunctionElement<unknown>

    @@ -591,22 +588,19 @@

    Returns PromiseBadge
  • - CLAAssistantBadge -
    • -
  • - CodecovBadge + CircleCIBadge
  • ContributingSection
  • - DescriptionFromPkg + ContributorsSectionFromPkg
  • - DevDependenciesBadge + CoverallsBadge
  • - DiscordBadge + DependenciesBadge
  • ExamplesFromPkg @@ -615,25 +609,28 @@

    Returns PromiseFragment

  • - GithubTopLanguageBadge + GithubIssuesBadge +
    • +
  • + GithubWorkflowBadge
  • - HitsBadge + HacktoberfestBadge
  • - JsxReadmeBadge + HomepageFromPkg
  • - LicenseFromPkg + LicenseBadge
  • - NpmVersionBadge + NpmBundleSizeBadge
  • - SemanticReleaseBadge + NpmDownloadsBadge
  • - renderToFile + TitleFromPkg