readme-aura 0.3.3 → 0.3.6

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.
Files changed (5) hide show
  1. package/README.md +50 -1
  2. package/dist/components/SocialMediaButton.js +1 -1
  3. package/dist/components/SocialMediaButton.js.map +1 -1
  4. package/package.json +1 -1
  5. package/readme.source.md +49 -0
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- [![readme-aura-component-0](./.github/assets/readme-aura-component-0-9e1dfb4e.svg "Generated by readme-aura")](https://www.npmjs.com/package/readme-aura)
1
+ [![readme-aura-component-0](./.github/assets/readme-aura-component-0-fc6c9a40.svg "Generated by readme-aura")](https://www.npmjs.com/package/readme-aura)
2
2
 
3
3
  Write custom **React/JSX components** directly inside your Markdown, and readme-aura will render them into beautiful SVGs that work on GitHub.
4
4
 
@@ -102,6 +102,55 @@ jobs:
102
102
  * **Clickable Images** – Add a link: ` ```aura link="https://example.com" ` – clicking the image opens the URL
103
103
  * **GitHub-Compatible** – Output is pure Markdown + SVG, works everywhere
104
104
 
105
+ ## Components
106
+
107
+ readme-aura ships with ready-to-use components you can drop into any ` ```aura ` block — no imports needed. They are automatically available in the JSX context.
108
+
109
+ <table>
110
+ <thead>
111
+ <tr>
112
+ <th>Code</th>
113
+ <th>Result</th>
114
+ </tr>
115
+ </thead>
116
+ <tbody>
117
+ <tr>
118
+ <td>
119
+ <pre style="font-size: 8px; line-height: 1.35; margin: 0;"><code>&lt;SocialMediaButton
120
+ icon="https://raw.githubusercontent.com/collectioneur/readme-aura/main/assets/readme-aura-logo.png"
121
+ text="readme-aura"
122
+ backgroundColor="#111111"
123
+ width={150}
124
+ height={44}
125
+ gradientStops={[
126
+ { offset: '0%', color: '#ffffff' },
127
+ { offset: '10%', color: '#111111' },
128
+ { offset: '50%', color: '#eeeeee' },
129
+ { offset: '60%', color: '#1af4ff' },
130
+ { offset: '80%', color: '#111111' },
131
+ { offset: '100%', color: '#555555' },
132
+ ]}
133
+ iconSize="30"
134
+ /&gt;</code></pre>
135
+ </td>
136
+ <td><img src="assets/readme-aura-button.svg" alt="SocialMediaButton" /></td>
137
+ </tr>
138
+ </tbody>
139
+ </table>
140
+
141
+ | Prop | Default | Description |
142
+ |------|---------|-------------|
143
+ | `icon` | — | Icon image path or URL |
144
+ | `text` | — | Button label |
145
+ | `backgroundColor` | `#111111` | Fill color |
146
+ | `textColor` | `#f5f5f5` | Label color |
147
+ | `fontSize` | `13` | Label font size |
148
+ | `width` / `height` | `150` / `40` | Button dimensions |
149
+ | `iconSize` | `18` | Icon dimensions |
150
+ | `borderColor` | `#AAAAAA` | Outer border color |
151
+ | `gradientStops` | holographic | Animated gradient colors |
152
+ | `gradientStrokeWidth` | `2` | Gradient border thickness |
153
+
105
154
  ## Animations
106
155
 
107
156
  You can add **CSS-based SVG animations** using the `<style>` injection mechanism. Satori renders a static frame at build time; the browser animates the SVG when it is displayed (e.g. on GitHub).
package/dist/components/SocialMediaButton.js CHANGED
@@ -105,7 +105,7 @@ export function makeSocialMediaButton(h) {
105
105
  width: iconSize,
106
106
  height: iconSize,
107
107
  alt: '',
108
- style: { flexShrink: 0, display: 'block' },
108
+ style: { flexShrink: 0, display: 'block', width: iconSize, height: iconSize },
109
109
  }), h('span', {
110
110
  style: {
111
111
  fontFamily: 'Inter, sans-serif',
package/dist/components/SocialMediaButton.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"SocialMediaButton.js","sourceRoot":"","sources":["../../src/components/SocialMediaButton.ts"],"names":[],"mappings":"AAqBA,MAAM,sBAAsB,GAAmB;IAC7C,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE;IAClC,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE;IACnC,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE;IACnC,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE;IACnC,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE;IACnC,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE;CACrC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB,CAAC,CAAI;IACxC,OAAO,SAAS,iBAAiB,CAAC,EAChC,IAAI,EACJ,IAAI,EACJ,eAAe,GAAG,SAAS,EAC3B,SAAS,GAAG,SAAS,EACrB,QAAQ,GAAG,EAAE,EACb,KAAK,GAAG,GAAG,EACX,MAAM,GAAG,EAAE,EACX,aAAa,GAAG,sBAAsB,EACtC,mBAAmB,GAAG,CAAC,EACvB,WAAW,GAAG,SAAS,EACvB,QAAQ,GAAG,EAAE,GACU;QACvB,MAAM,UAAU,GAAG,YAAY,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC,EAAE,CAAC;QACnE,MAAM,YAAY,GAAG,MAAM,GAAG,CAAC,CAAC;QAEhC,MAAM,WAAW,GAAG,mBAAmB,GAAG,CAAC,GAAG,IAAI,CAAC;QACnD,MAAM,MAAM,GAAG,KAAK,GAAG,WAAW,GAAG,CAAC,CAAC;QACvC,MAAM,MAAM,GAAG,MAAM,GAAG,WAAW,GAAG,CAAC,CAAC;QACxC,MAAM,OAAO,GAAG,MAAM,GAAG,CAAC,CAAC;QAE3B,MAAM,WAAW,GAAG,IAAI,CAAC;QACzB,MAAM,MAAM,GAAG,KAAK,GAAG,WAAW,GAAG,CAAC,CAAC;QACvC,MAAM,MAAM,GAAG,MAAM,GAAG,WAAW,GAAG,CAAC,CAAC;QACxC,MAAM,OAAO,GAAG,MAAM,GAAG,CAAC,CAAC;QAE3B,OAAO,CAAC,CACN,KAAK,EACL;YACE,KAAK,EAAE;gBACL,QAAQ,EAAE,UAAU;gBACpB,OAAO,EAAE,MAAM;gBACf,KAAK,EAAE,MAAM;gBACb,MAAM,EAAE,MAAM;gBACd,eAAe;gBACf,YAAY;gBACZ,SAAS,EAAE,YAAY;aACxB;SACF,EAED,CAAC,CACC,KAAK,EACL;YACE,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC;YACpB,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;YACtB,OAAO,EAAE,OAAO,KAAK,IAAI,MAAM,EAAE;YACjC,QAAQ,EAAE,SAAS;YACnB,KAAK,EAAE,4BAA4B;YACnC,KAAK,EAAE;gBACL,QAAQ,EAAE,UAAU;gBACpB,GAAG,EAAE,CAAC;gBACN,IAAI,EAAE,CAAC;gBACP,aAAa,EAAE,MAAM;gBACrB,QAAQ,EAAE,SAAS;aACpB;SACF,EACD,CAAC,CACC,MAAM,EACN,IAAI,EACJ,CAAC,CACC,gBAAgB,EAChB;YACE,EAAE,EAAE,UAAU;YACd,aAAa,EAAE,mBAAmB;YAClC,EAAE,EAAE,GAAG;YACP,EAAE,EAAE,GAAG;YACP,EAAE,EAAE,GAAG;YACP,EAAE,EAAE,GAAG;SACR,EACD,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAC5B,CAAC,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,CAC1D,EACD,CAAC,CAAC,kBAAkB,EAAE;YACpB,aAAa,EAAE,mBAAmB;YAClC,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,WAAW;YACjB,EAAE,EAAE,aAAa;YACjB,GAAG,EAAE,IAAI;YACT,WAAW,EAAE,YAAY;SAC1B,CAAC,CACH,CACF,EACD,CAAC,CAAC,MAAM,EAAE;YACR,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC;YACtB,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC;YACtB,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC;YACrB,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;YACtB,EAAE,EAAE,MAAM,CAAC,OAAO,CAAC;YACnB,EAAE,EAAE,MAAM,CAAC,OAAO,CAAC;YACnB,IAAI,EAAE,MAAM;YACZ,MAAM,EAAE,QAAQ,UAAU,GAAG;YAC7B,WAAW,EAAE,MAAM,CAAC,mBAAmB,CAAC;YACxC,aAAa,EAAE,OAAO;YACtB,cAAc,EAAE,OAAO;SACxB,CAAC,EACF,CAAC,CAAC,MAAM,EAAE;YACR,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC;YACtB,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC;YACtB,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC;YACrB,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;YACtB,EAAE,EAAE,MAAM,CAAC,OAAO,CAAC;YACnB,EAAE,EAAE,MAAM,CAAC,OAAO,CAAC;YACnB,IAAI,EAAE,MAAM;YACZ,MAAM,EAAE,WAAW;YACnB,WAAW,EAAE,KAAK;YAClB,aAAa,EAAE,OAAO;YACtB,cAAc,EAAE,OAAO;SACxB,CAAC,CACH,EAED,CAAC,CACC,KAAK,EACL;YACE,KAAK,EAAE;gBACL,QAAQ,EAAE,UAAU;gBACpB,OAAO,EAAE,MAAM;gBACf,aAAa,EAAE,KAAK;gBACpB,UAAU,EAAE,QAAQ;gBACpB,cAAc,EAAE,QAAQ;gBACxB,GAAG,EAAE,CAAC;gBACN,IAAI,EAAE,CAAC;gBACP,KAAK,EAAE,MAAM;gBACb,MAAM,EAAE,MAAM;gBACd,WAAW,EAAE,EAAE;gBACf,YAAY,EAAE,EAAE;gBAChB,SAAS,EAAE,YAAY;aACxB;SACF,EACD,CAAC,CAAC,KAAK,EAAE;YACP,GAAG,EAAE,IAAI;YACT,KAAK,EAAE,QAAQ;YACf,MAAM,EAAE,QAAQ;YAChB,GAAG,EAAE,EAAE;YACP,KAAK,EAAE,EAAE,UAAU,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE;SAC3C,CAAC,EACF,CAAC,CACC,MAAM,EACN;YACE,KAAK,EAAE;gBACL,UAAU,EAAE,mBAAmB;gBAC/B,UAAU,EAAE,GAAG;gBACf,QAAQ;gBACR,KAAK,EAAE,SAAS;gBAChB,aAAa,EAAE,QAAQ;aACxB;SACF,EACD,IAAI,CACL,CACF,CACF,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC"}
1
+ {"version":3,"file":"SocialMediaButton.js","sourceRoot":"","sources":["../../src/components/SocialMediaButton.ts"],"names":[],"mappings":"AAqBA,MAAM,sBAAsB,GAAmB;IAC7C,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE;IAClC,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE;IACnC,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE;IACnC,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE;IACnC,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE;IACnC,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE;CACrC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB,CAAC,CAAI;IACxC,OAAO,SAAS,iBAAiB,CAAC,EAChC,IAAI,EACJ,IAAI,EACJ,eAAe,GAAG,SAAS,EAC3B,SAAS,GAAG,SAAS,EACrB,QAAQ,GAAG,EAAE,EACb,KAAK,GAAG,GAAG,EACX,MAAM,GAAG,EAAE,EACX,aAAa,GAAG,sBAAsB,EACtC,mBAAmB,GAAG,CAAC,EACvB,WAAW,GAAG,SAAS,EACvB,QAAQ,GAAG,EAAE,GACU;QACvB,MAAM,UAAU,GAAG,YAAY,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC,EAAE,CAAC;QACnE,MAAM,YAAY,GAAG,MAAM,GAAG,CAAC,CAAC;QAEhC,MAAM,WAAW,GAAG,mBAAmB,GAAG,CAAC,GAAG,IAAI,CAAC;QACnD,MAAM,MAAM,GAAG,KAAK,GAAG,WAAW,GAAG,CAAC,CAAC;QACvC,MAAM,MAAM,GAAG,MAAM,GAAG,WAAW,GAAG,CAAC,CAAC;QACxC,MAAM,OAAO,GAAG,MAAM,GAAG,CAAC,CAAC;QAE3B,MAAM,WAAW,GAAG,IAAI,CAAC;QACzB,MAAM,MAAM,GAAG,KAAK,GAAG,WAAW,GAAG,CAAC,CAAC;QACvC,MAAM,MAAM,GAAG,MAAM,GAAG,WAAW,GAAG,CAAC,CAAC;QACxC,MAAM,OAAO,GAAG,MAAM,GAAG,CAAC,CAAC;QAE3B,OAAO,CAAC,CACN,KAAK,EACL;YACE,KAAK,EAAE;gBACL,QAAQ,EAAE,UAAU;gBACpB,OAAO,EAAE,MAAM;gBACf,KAAK,EAAE,MAAM;gBACb,MAAM,EAAE,MAAM;gBACd,eAAe;gBACf,YAAY;gBACZ,SAAS,EAAE,YAAY;aACxB;SACF,EAED,CAAC,CACC,KAAK,EACL;YACE,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC;YACpB,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;YACtB,OAAO,EAAE,OAAO,KAAK,IAAI,MAAM,EAAE;YACjC,QAAQ,EAAE,SAAS;YACnB,KAAK,EAAE,4BAA4B;YACnC,KAAK,EAAE;gBACL,QAAQ,EAAE,UAAU;gBACpB,GAAG,EAAE,CAAC;gBACN,IAAI,EAAE,CAAC;gBACP,aAAa,EAAE,MAAM;gBACrB,QAAQ,EAAE,SAAS;aACpB;SACF,EACD,CAAC,CACC,MAAM,EACN,IAAI,EACJ,CAAC,CACC,gBAAgB,EAChB;YACE,EAAE,EAAE,UAAU;YACd,aAAa,EAAE,mBAAmB;YAClC,EAAE,EAAE,GAAG;YACP,EAAE,EAAE,GAAG;YACP,EAAE,EAAE,GAAG;YACP,EAAE,EAAE,GAAG;SACR,EACD,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAC5B,CAAC,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,CAC1D,EACD,CAAC,CAAC,kBAAkB,EAAE;YACpB,aAAa,EAAE,mBAAmB;YAClC,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,WAAW;YACjB,EAAE,EAAE,aAAa;YACjB,GAAG,EAAE,IAAI;YACT,WAAW,EAAE,YAAY;SAC1B,CAAC,CACH,CACF,EACD,CAAC,CAAC,MAAM,EAAE;YACR,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC;YACtB,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC;YACtB,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC;YACrB,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;YACtB,EAAE,EAAE,MAAM,CAAC,OAAO,CAAC;YACnB,EAAE,EAAE,MAAM,CAAC,OAAO,CAAC;YACnB,IAAI,EAAE,MAAM;YACZ,MAAM,EAAE,QAAQ,UAAU,GAAG;YAC7B,WAAW,EAAE,MAAM,CAAC,mBAAmB,CAAC;YACxC,aAAa,EAAE,OAAO;YACtB,cAAc,EAAE,OAAO;SACxB,CAAC,EACF,CAAC,CAAC,MAAM,EAAE;YACR,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC;YACtB,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC;YACtB,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC;YACrB,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;YACtB,EAAE,EAAE,MAAM,CAAC,OAAO,CAAC;YACnB,EAAE,EAAE,MAAM,CAAC,OAAO,CAAC;YACnB,IAAI,EAAE,MAAM;YACZ,MAAM,EAAE,WAAW;YACnB,WAAW,EAAE,KAAK;YAClB,aAAa,EAAE,OAAO;YACtB,cAAc,EAAE,OAAO;SACxB,CAAC,CACH,EAED,CAAC,CACC,KAAK,EACL;YACE,KAAK,EAAE;gBACL,QAAQ,EAAE,UAAU;gBACpB,OAAO,EAAE,MAAM;gBACf,aAAa,EAAE,KAAK;gBACpB,UAAU,EAAE,QAAQ;gBACpB,cAAc,EAAE,QAAQ;gBACxB,GAAG,EAAE,CAAC;gBACN,IAAI,EAAE,CAAC;gBACP,KAAK,EAAE,MAAM;gBACb,MAAM,EAAE,MAAM;gBACd,WAAW,EAAE,EAAE;gBACf,YAAY,EAAE,EAAE;gBAChB,SAAS,EAAE,YAAY;aACxB;SACF,EACD,CAAC,CAAC,KAAK,EAAE;YACP,GAAG,EAAE,IAAI;YACT,KAAK,EAAE,QAAQ;YACf,MAAM,EAAE,QAAQ;YAChB,GAAG,EAAE,EAAE;YACP,KAAK,EAAE,EAAE,UAAU,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE;SAC9E,CAAC,EACF,CAAC,CACC,MAAM,EACN;YACE,KAAK,EAAE;gBACL,UAAU,EAAE,mBAAmB;gBAC/B,UAAU,EAAE,GAAG;gBACf,QAAQ;gBACR,KAAK,EAAE,SAAS;gBAChB,aAAa,EAAE,QAAQ;aACxB;SACF,EACD,IAAI,CACL,CACF,CACF,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "readme-aura",
3
- "version": "0.3.3",
3
+ "version": "0.3.6",
4
4
  "description": "Next-Gen README generator for GitHub — render React/JSX components to SVG inside Markdown",
5
5
  "repository": {
6
6
  "type": "git",
package/readme.source.md CHANGED
@@ -377,6 +377,55 @@ jobs:
377
377
  - **Clickable Images** – Add a link: `` ```aura link="https://example.com" `` – clicking the image opens the URL
378
378
  - **GitHub-Compatible** – Output is pure Markdown + SVG, works everywhere
379
379
 
380
+ ## Components
381
+
382
+ readme-aura ships with ready-to-use components you can drop into any `` ```aura `` block — no imports needed. They are automatically available in the JSX context.
383
+
384
+ <table>
385
+ <thead>
386
+ <tr>
387
+ <th>Code</th>
388
+ <th>Result</th>
389
+ </tr>
390
+ </thead>
391
+ <tbody>
392
+ <tr>
393
+ <td>
394
+ <pre style="font-size: 8px; line-height: 1.35; margin: 0;"><code>&lt;SocialMediaButton
395
+ icon="https://raw.githubusercontent.com/collectioneur/readme-aura/main/assets/readme-aura-logo.png"
396
+ text="readme-aura"
397
+ backgroundColor="#111111"
398
+ width={150}
399
+ height={44}
400
+ gradientStops={[
401
+ { offset: '0%', color: '#ffffff' },
402
+ { offset: '10%', color: '#111111' },
403
+ { offset: '50%', color: '#eeeeee' },
404
+ { offset: '60%', color: '#1af4ff' },
405
+ { offset: '80%', color: '#111111' },
406
+ { offset: '100%', color: '#555555' },
407
+ ]}
408
+ iconSize="30"
409
+ /&gt;</code></pre>
410
+ </td>
411
+ <td><img src="assets/readme-aura-button.svg" alt="SocialMediaButton" /></td>
412
+ </tr>
413
+ </tbody>
414
+ </table>
415
+
416
+ | Prop | Default | Description |
417
+ |------|---------|-------------|
418
+ | `icon` | — | Icon image path or URL |
419
+ | `text` | — | Button label |
420
+ | `backgroundColor` | `#111111` | Fill color |
421
+ | `textColor` | `#f5f5f5` | Label color |
422
+ | `fontSize` | `13` | Label font size |
423
+ | `width` / `height` | `150` / `40` | Button dimensions |
424
+ | `iconSize` | `18` | Icon dimensions |
425
+ | `borderColor` | `#AAAAAA` | Outer border color |
426
+ | `gradientStops` | holographic | Animated gradient colors |
427
+ | `gradientStrokeWidth` | `2` | Gradient border thickness |
428
+
380
429
  ## Animations
381
430
 
382
431
  You can add **CSS-based SVG animations** using the `<style>` injection mechanism. Satori renders a static frame at build time; the browser animates the SVG when it is displayed (e.g. on GitHub).