readme-aura 0.4.9 → 0.4.11
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.
- package/README.md +19 -16
- package/dist/cli.js +1 -1
- package/dist/cli.js.map +1 -1
- package/dist/init.d.ts +1 -1
- package/dist/init.js +2 -2
- package/dist/init.js.map +1 -1
- package/package.json +1 -1
- package/readme.source.md +45 -10
package/README.md
CHANGED
|
@@ -1,8 +1,12 @@
|
|
|
1
|
-
[](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
|
|
|
5
|
-
GitHub strips all JS and CSS from README files. This tool lets you bypass that limitation by compiling your designs into static SVG images at build time.
|
|
5
|
+
GitHub strips all JS and CSS from README files. This tool lets you bypass that limitation by compiling your designs into static SVG images at build time. <br/> <br/> <br/>
|
|
6
|
+
|
|
7
|
+
[](https://github.com/collectioneur/readme-aura/blob/main/CONTRIBUTING.md)
|
|
8
|
+
|
|
9
|
+
Made your profile unique with readme-aura? Drop your `readme.source.md` into [`examples/custom-templates/`](https://github.com/collectioneur/readme-aura/tree/main/examples/custom-templates) and anyone will be able to install your design with a single command. See the [contributing guide](https://github.com/collectioneur/readme-aura/blob/main/CONTRIBUTING.md) for details.
|
|
6
10
|
|
|
7
11
|
## How It Works
|
|
8
12
|
|
|
@@ -11,7 +15,7 @@ GitHub strips all JS and CSS from README files. This tool lets you bypass that l
|
|
|
11
15
|
3. Preview locally with `npx readme-aura build` – JSX gets rendered to SVG via [Vercel Satori](https://github.com/vercel/satori)
|
|
12
16
|
4. Push to `main` – the GitHub Action auto-generates your `README.md`
|
|
13
17
|
|
|
14
|
-
[](https://www.npmjs.com/package/readme-aura)
|
|
15
19
|
|
|
16
20
|
## Quick Start
|
|
17
21
|
|
|
@@ -29,7 +33,7 @@ npx readme-aura build
|
|
|
29
33
|
|
|
30
34
|
That's it. Push to `main` and the workflow will auto-generate your `README.md` on every push.
|
|
31
35
|
|
|
32
|
-
> `init` auto-detects profile repos (`username/username`) and picks the right template.
|
|
36
|
+
> `init` auto-detects profile repos (`username/username`) and picks the right default template.
|
|
33
37
|
|
|
34
38
|
### Commands
|
|
35
39
|
|
|
@@ -58,16 +62,15 @@ That's it. Push to `main` and the workflow will auto-generate your `README.md` o
|
|
|
58
62
|
|
|
59
63
|
### Example Templates
|
|
60
64
|
|
|
61
|
-
Pass any
|
|
65
|
+
Pass any template name from the [`examples/custom-templates/`](https://github.com/collectioneur/readme-aura/tree/main/examples/custom-templates) folder as `--template` and `init` will fetch its `readme.source.md` directly from GitHub and write it to your project:
|
|
62
66
|
|
|
63
67
|
```bash
|
|
64
68
|
npx readme-aura init --template DarkOrbs
|
|
65
69
|
npx readme-aura init --template PurpleGlow
|
|
66
70
|
npx readme-aura init --template LightOrbs
|
|
67
|
-
npx readme-aura init --template SocialMediaButton
|
|
68
71
|
```
|
|
69
72
|
|
|
70
|
-
No extra downloads, no local files needed
|
|
73
|
+
No extra downloads, no local files needed - the template is pulled on the fly and placed in `readme.source.md`, ready to build. Run `npx readme-aura build` right after and you get a working README.
|
|
71
74
|
|
|
72
75
|
## What `init` Creates
|
|
73
76
|
|
|
@@ -106,7 +109,7 @@ jobs:
|
|
|
106
109
|
|
|
107
110
|
## Features
|
|
108
111
|
|
|
109
|
-
[](https://www.npmjs.com/package/readme-aura)
|
|
110
113
|
|
|
111
114
|
* **Write React/JSX** – Use familiar `style={{ }}` syntax with flexbox, gradients, shadows
|
|
112
115
|
* **Powered by Satori** – Vercel's engine converts JSX to SVG without a browser
|
|
@@ -128,7 +131,7 @@ All parameters are written directly on the opening fence line of an ` ```aura `
|
|
|
128
131
|
| `inline` | flag | – | Render as an inline `<img>` instead of a block paragraph. Consecutive inline blocks are automatically joined on one line |
|
|
129
132
|
| `align` | `center` | `left` | `right` | – | Wrap a group of consecutive inline blocks in `<p align="...">`. Only meaningful when `inline` is set |
|
|
130
133
|
|
|
131
|
-
**Example
|
|
134
|
+
**Example – centered row of social buttons:**
|
|
132
135
|
|
|
133
136
|
````markdown
|
|
134
137
|
```aura width=120 height=44 link="https://github.com/you" inline align=center
|
|
@@ -147,7 +150,7 @@ Output in README.md:
|
|
|
147
150
|
</p>
|
|
148
151
|
```
|
|
149
152
|
|
|
150
|
-
> The `align` value is read from the first block in the group that declares it. Blocks without `align` still join the same group
|
|
153
|
+
> The `align` value is read from the first block in the group that declares it. Blocks without `align` still join the same group – only the wrapper is controlled by the flag.
|
|
151
154
|
|
|
152
155
|
## Components
|
|
153
156
|
|
|
@@ -195,8 +198,8 @@ readme-aura ships with ready-to-use components you can drop into any ` ```aura `
|
|
|
195
198
|
|
|
196
199
|
| Prop | Default | Description |
|
|
197
200
|
|------|---------|-------------|
|
|
198
|
-
| `icon` |
|
|
199
|
-
| `text` |
|
|
201
|
+
| `icon` | – | Icon image path or URL |
|
|
202
|
+
| `text` | – | Button label |
|
|
200
203
|
| `backgroundColor` | `#111111` | Fill color |
|
|
201
204
|
| `textColor` | `#f5f5f5` | Label color |
|
|
202
205
|
| `fontSize` | `13` | Label font size |
|
|
@@ -208,7 +211,7 @@ readme-aura ships with ready-to-use components you can drop into any ` ```aura `
|
|
|
208
211
|
|
|
209
212
|
## Animations
|
|
210
213
|
|
|
211
|
-
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).
|
|
214
|
+
You can add **CSS-based SVG animations** using the `<style>` injection mechanism, or **SMIL animations** (`<animate>`, `<animateTransform>`, `<animateMotion>`) directly on SVG elements. Satori renders a static frame at build time; the browser animates the SVG when it is displayed (e.g. on GitHub).
|
|
212
215
|
|
|
213
216
|
**How it works:** Add a `<style>` block in your JSX. Define `@keyframes` and apply them to elements by `#id` or `.class`. The renderer extracts and injects the CSS into the final SVG.
|
|
214
217
|
|
|
@@ -216,13 +219,13 @@ You can add **CSS-based SVG animations** using the `<style>` injection mechanism
|
|
|
216
219
|
|
|
217
220
|
**Targeting:** Use `id` on SVG elements (`<ellipse id="glow">`, `<g id="group">`) and reference them in CSS: `#glow { animation: pulse 2s infinite; }`. Raw SVG elements preserve `id`; Satori-rendered HTML may not always preserve `className`.
|
|
218
221
|
|
|
219
|
-
[](https://www.npmjs.com/package/readme-aura)
|
|
220
223
|
|
|
221
|
-
**Limitations:** No JavaScript
|
|
224
|
+
**Limitations:** No JavaScript. GitHub strips scripts but supports both CSS animations and SMIL. Prefer `transform` and `opacity` for best CSS compatibility.
|
|
222
225
|
|
|
223
226
|
## Tech Stack
|
|
224
227
|
|
|
225
|
-
[](https://www.npmjs.com/package/readme-aura)
|
|
226
229
|
|
|
227
230
|
## If You Use readme-aura
|
|
228
231
|
|
package/dist/cli.js
CHANGED
|
@@ -19,7 +19,7 @@ program
|
|
|
19
19
|
program
|
|
20
20
|
.command('init')
|
|
21
21
|
.description('Scaffold readme-aura in your project (workflow, source template, gitignore audit)')
|
|
22
|
-
.option('--template <name>', 'Template: profile, project (auto-detected), or
|
|
22
|
+
.option('--template <name>', 'Template: profile, project (auto-detected), or a custom template name like DarkOrbs, PurpleGlow (fetched from examples/custom-templates/ on GitHub)')
|
|
23
23
|
.option('--force', 'Overwrite existing files', false)
|
|
24
24
|
.action(async (opts) => {
|
|
25
25
|
console.log('\n readme-aura init\n');
|
package/dist/cli.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AACrE,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,MAAM,EAAE,OAAO,EAAE,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,iBAAiB,CAAwB,CAAC;AAC7F,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AACtE,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAChE,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,gBAAgB,EAChB,kBAAkB,EAClB,oBAAoB,EACpB,kBAAkB,GACnB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAGxC,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;AAE9B,OAAO;KACJ,IAAI,CAAC,aAAa,CAAC;KACnB,WAAW,CAAC,gFAAgF,CAAC;KAC7F,OAAO,CAAC,OAAO,CAAC,CAAC;AAEpB,OAAO;KACJ,OAAO,CAAC,MAAM,CAAC;KACf,WAAW,CAAC,mFAAmF,CAAC;KAChG,MAAM,CACL,mBAAmB,EACnB,
|
|
1
|
+
{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AACrE,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,MAAM,EAAE,OAAO,EAAE,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,iBAAiB,CAAwB,CAAC;AAC7F,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AACtE,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAChE,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,gBAAgB,EAChB,kBAAkB,EAClB,oBAAoB,EACpB,kBAAkB,GACnB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAGxC,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;AAE9B,OAAO;KACJ,IAAI,CAAC,aAAa,CAAC;KACnB,WAAW,CAAC,gFAAgF,CAAC;KAC7F,OAAO,CAAC,OAAO,CAAC,CAAC;AAEpB,OAAO;KACJ,OAAO,CAAC,MAAM,CAAC;KACf,WAAW,CAAC,mFAAmF,CAAC;KAChG,MAAM,CACL,mBAAmB,EACnB,qJAAqJ,CACtJ;KACA,MAAM,CAAC,SAAS,EAAE,0BAA0B,EAAE,KAAK,CAAC;KACpD,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;IACrB,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC;IAEtC,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC;QAC/B,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,KAAK,EAAE,IAAI,CAAC,KAAK;KAClB,CAAC,CAAC;IAEH,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QAClB,OAAO,CAAC,GAAG,CAAC,gBAAgB,MAAM,CAAC,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;IAC3E,CAAC;IACD,OAAO,CAAC,GAAG,CAAC,gBAAgB,MAAM,CAAC,QAAQ,IAAI,CAAC,CAAC;IAEjD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QAClC,OAAO,CAAC,GAAG,CAAC,gBAAgB,IAAI,EAAE,CAAC,CAAC;IACtC,CAAC;IACD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QAClC,OAAO,CAAC,GAAG,CAAC,gBAAgB,IAAI,6CAA6C,CAAC,CAAC;IACjF,CAAC;IACD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,cAAc,EAAE,CAAC;QACzC,OAAO,CAAC,GAAG,CAAC,4BAA4B,IAAI,EAAE,CAAC,CAAC;IAClD,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;IAC/B,OAAO,CAAC,GAAG,CAAC,uDAAuD,CAAC,CAAC;IACrE,OAAO,CAAC,GAAG,CAAC,6CAA6C,CAAC,CAAC;IAC3D,OAAO,CAAC,GAAG,CAAC,qEAAqE,CAAC,CAAC;AACrF,CAAC,CAAC,CAAC;AAEL,OAAO;KACJ,OAAO,CAAC,OAAO,CAAC;KAChB,WAAW,CAAC,+DAA+D,CAAC;KAC5E,MAAM,CAAC,qBAAqB,EAAE,sBAAsB,EAAE,kBAAkB,CAAC;KACzE,MAAM,CAAC,qBAAqB,EAAE,sBAAsB,EAAE,WAAW,CAAC;KAClE,MAAM,CAAC,qBAAqB,EAAE,uCAAuC,EAAE,gBAAgB,CAAC;KACxF,MAAM,CAAC,wBAAwB,EAAE,oDAAoD,CAAC;KACtF,MAAM,CACL,8BAA8B,EAC9B,4DAA4D,CAC7D;KACA,MAAM,CAAC,4BAA4B,EAAE,sDAAsD,CAAC;KAC5F,MAAM,CAAC,iBAAiB,EAAE,6DAA6D,CAAC;KACxF,MAAM,CAAC,eAAe,EAAE,4DAA4D,CAAC;KACrF,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;IACrB,MAAM,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACxC,MAAM,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACxC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC;IAE9B,OAAO,CAAC,GAAG,CAAC,oBAAoB,OAAO,IAAI,CAAC,CAAC;IAC7C,OAAO,CAAC,GAAG,CAAC,cAAc,UAAU,EAAE,CAAC,CAAC;IACxC,OAAO,CAAC,GAAG,CAAC,cAAc,UAAU,EAAE,CAAC,CAAC;IACxC,OAAO,CAAC,GAAG,CAAC,cAAc,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IAEhD,IAAI,CAAC;QACH,MAAM,WAAW,GAAG,MAAM,WAAW,CAAC,UAAU,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;QACzE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,WAAW,CAAC;QAC1C,IAAI,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC;QAE/B,MAAM,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAErD,4DAA4D;QAC5D,IAAI,MAAM,GAAsB,IAAI,CAAC;QACrC,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,gBAAgB,EAAE,CAAC;QACzD,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC;QAEjE,IAAI,UAAU,EAAE,CAAC;YACf,OAAO,CAAC,GAAG,CAAC,iBAAiB,UAAU,EAAE,CAAC,CAAC;YAC3C,IAAI,WAAW,EAAE,CAAC;gBAChB,IAAI,CAAC;oBACH,OAAO,CAAC,GAAG,CAAC,2BAA2B,CAAC,CAAC;oBACzC,MAAM,GAAG,MAAM,eAAe,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;oBACxD,OAAO,CAAC,GAAG,CACT,cAAc,MAAM,CAAC,KAAK,CAAC,UAAU,WAAW,MAAM,CAAC,KAAK,CAAC,UAAU,WAAW,MAAM,CAAC,SAAS,CAAC,MAAM,YAAY,CACtH,CAAC;gBACJ,CAAC;gBAAC,OAAO,GAAG,EAAE,CAAC;oBACb,OAAO,CAAC,IAAI,CAAC,iCAAkC,GAAa,CAAC,OAAO,EAAE,CAAC,CAAC;oBACxE,OAAO,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC;oBAC/C,MAAM,GAAG,oBAAoB,CAAC,UAAU,CAAC,CAAC;gBAC5C,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,GAAG,CAAC,wDAAwD,CAAC,CAAC;gBACtE,MAAM,GAAG,oBAAoB,CAAC,UAAU,CAAC,CAAC;YAC5C,CAAC;QACH,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,GAAG,CAAC,mEAAmE,CAAC,CAAC;QACnF,CAAC;QAED,8DAA8D;QAC9D,IAAI,QAAQ,GAA0B,IAAI,CAAC;QAC3C,MAAM,MAAM,GAAG,kBAAkB,EAAE,CAAC;QACpC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,MAAM,EAAE,KAAK,IAAI,IAAI,CAAC;QAClD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI,MAAM,EAAE,IAAI,IAAI,IAAI,CAAC;QAE/C,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;YAClB,IAAI,WAAW,EAAE,CAAC;gBAChB,IAAI,CAAC;oBACH,OAAO,CAAC,GAAG,CAAC,oBAAoB,KAAK,IAAI,IAAI,KAAK,CAAC,CAAC;oBACpD,QAAQ,GAAG,MAAM,mBAAmB,CAAC,KAAK,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;oBAC/D,OAAO,CAAC,GAAG,CACT,mBAAmB,KAAK,IAAI,IAAI,MAAM,QAAQ,CAAC,KAAK,WAAW,QAAQ,CAAC,KAAK,QAAQ,CACtF,CAAC;gBACJ,CAAC;gBAAC,OAAO,GAAG,EAAE,CAAC;oBACb,OAAO,CAAC,IAAI,CAAC,+BAAgC,GAAa,CAAC,OAAO,EAAE,CAAC,CAAC;oBACtE,OAAO,CAAC,IAAI,CAAC,qCAAqC,CAAC,CAAC;oBACpD,QAAQ,GAAG,kBAAkB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;gBAC7C,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,GAAG,CAAC,uDAAuD,CAAC,CAAC;gBACrE,QAAQ,GAAG,kBAAkB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YAC7C,CAAC;QACH,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,GAAG,CAAC,gEAAgE,CAAC,CAAC;QAChF,CAAC;QAED,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACxB,OAAO,CAAC,GAAG,CAAC,0CAA0C,CAAC,CAAC;QAC1D,CAAC;aAAM,CAAC;YACN,aAAa;YACb,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;YACpC,IAAI,KAAmB,CAAC;YACxB,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAClB,KAAK,GAAG,MAAM,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAC9C,OAAO,CAAC,GAAG,CAAC,YAAY,KAAK,CAAC,MAAM,iBAAiB,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YACjF,CAAC;iBAAM,CAAC;gBACN,KAAK,GAAG,MAAM,gBAAgB,EAAE,CAAC;gBACjC,OAAO,CAAC,GAAG,CAAC,YAAY,KAAK,CAAC,MAAM,kBAAkB,CAAC,CAAC;YAC1D,CAAC;YAED,mHAAmH;YACnH,MAAM,OAAO,GAA4B;gBACvC,MAAM,EAAE,MAAM,IAAI,IAAI;gBACtB,IAAI,EAAE,QAAQ,IAAI,IAAI;aACvB,CAAC;YACF,6DAA6D;YAC7D,OAAO,CAAC,iBAAiB,GAAG,qBAAqB,CAAC,aAAa,CAAC,CAAC;YAEjE,iFAAiF;YACjF,OAAO,CAAC,GAAG,CAAC,iBAAiB,MAAM,CAAC,MAAM,gBAAgB,CAAC,CAAC;YAC5D,MAAM,MAAM,GAAG,IAAI,GAAG,EAAkB,CAAC;YACzC,MAAM,YAAY,GAAa,EAAE,CAAC;YAClC,kEAAkE;YAClE,MAAM,cAAc,GAAG,IAAI,GAAG,EAAkB,CAAC;YACjD,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;gBAC3B,IAAI,CAAC;oBACH,MAAM,GAAG,GAAG,MAAM,WAAW,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;oBACpE,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;oBAC7B,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;oBACxE,MAAM,QAAQ,GAAG,yBAAyB,KAAK,CAAC,KAAK,IAAI,IAAI,MAAM,CAAC;oBACpE,MAAM,OAAO,GAAG,OAAO,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;oBAC7C,MAAM,SAAS,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;oBACvC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;oBAC5B,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;oBACnC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;wBAChB,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;oBAC5C,CAAC;yBAAM,CAAC;wBACN,QAAQ,GAAG,QAAQ,CAAC,UAAU,CAAC,yBAAyB,KAAK,CAAC,KAAK,MAAM,EAAE,QAAQ,CAAC,CAAC;oBACvF,CAAC;oBACD,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,CAAC,KAAK,iBAAiB,QAAQ,EAAE,CAAC,CAAC;gBAC9D,CAAC;gBAAC,OAAO,GAAG,EAAE,CAAC;oBACb,OAAO,CAAC,KAAK,CAAC,sBAAsB,KAAK,CAAC,KAAK,KAAM,GAAa,CAAC,OAAO,IAAI,CAAC,CAAC;oBAChF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;gBAClB,CAAC;YACH,CAAC;YAED,gDAAgD;YAChD,4EAA4E;YAC5E,gFAAgF;YAChF,IAAI,cAAc,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;gBAC5B,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,sCAAsC,EAAE,CAAC,QAAQ,EAAE,EAAE;oBAC/E,MAAM,UAAU,GAAG,iCAAiC,CAAC;oBACrD,MAAM,OAAO,GAAa,EAAE,CAAC;oBAC7B,IAAI,CAAC,CAAC;oBACN,OAAO,CAAC,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;wBAChD,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;oBACnC,CAAC;oBAED,MAAM,SAAS,GAAa,EAAE,CAAC;oBAC/B,IAAI,UAA8B,CAAC;oBAEnC,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;wBAC1B,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,GAAG,CAAC,CAAC;wBAClD,IAAI,CAAC,KAAK;4BAAE,SAAS;wBACrB,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;wBACnC,IAAI,IAAI,CAAC,KAAK,IAAI,CAAC,UAAU;4BAAE,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC;wBAEvD,MAAM,QAAQ,GAAG,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;wBACzC,IAAI,CAAC,QAAQ;4BAAE,SAAS;wBAExB,MAAM,MAAM,GAAG,aAAa,SAAS,IAAI,QAAQ,YAAY,IAAI,CAAC,KAAK,aAAa,IAAI,CAAC,MAAM,MAAM,CAAC;wBACtG,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,IAAI,CAAC,IAAI,KAAK,MAAM,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC;wBACzE,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;oBACvB,CAAC;oBAED,IAAI,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;oBAChC,IAAI,UAAU,EAAE,CAAC;wBACf,MAAM,GAAG,aAAa,UAAU,OAAO,MAAM,QAAQ,CAAC;oBACxD,CAAC;oBACD,OAAO,MAAM,CAAC;gBAChB,CAAC,CAAC,CAAC;YACL,CAAC;YAED,gDAAgD;YAChD,MAAM,gBAAgB,GACpB,2EAA2E,CAAC;YAC9E,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;YACnD,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE,CAAC;gBAC5B,IAAI,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;oBAChE,MAAM,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;gBACzC,CAAC;YACH,CAAC;QACH,CAAC;QAED,MAAM,SAAS,CAAC,UAAU,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC/C,OAAO,CAAC,GAAG,CAAC,kBAAkB,UAAU,EAAE,CAAC,CAAC;QAC5C,OAAO,CAAC,GAAG,CAAC,oBAAoB,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC1D,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAK,GAA6B,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACrD,OAAO,CAAC,KAAK,CAAC,qCAAqC,UAAU,IAAI,CAAC,CAAC;YACnE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;QACD,MAAM,GAAG,CAAC;IACZ,CAAC;AACH,CAAC,CAAC,CAAC;AAEL,OAAO,CAAC,KAAK,EAAE,CAAC"}
|
package/dist/init.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { type GitHubRemote } from './github.js';
|
|
2
2
|
export interface InitOptions {
|
|
3
3
|
cwd?: string;
|
|
4
|
-
/** 'profile', 'project', or any
|
|
4
|
+
/** 'profile', 'project', or any template name from examples/custom-templates/ (e.g. 'DarkOrbs') */
|
|
5
5
|
template?: string;
|
|
6
6
|
force?: boolean;
|
|
7
7
|
}
|
package/dist/init.js
CHANGED
|
@@ -5,8 +5,8 @@ import { parseGitHubRemote } from './github.js';
|
|
|
5
5
|
import { generateWorkflow } from './default-templates/workflow.js';
|
|
6
6
|
import { generateSourceProfile } from './default-templates/source-profile.js';
|
|
7
7
|
import { generateSourceProject } from './default-templates/source-project.js';
|
|
8
|
-
const EXAMPLES_RAW_BASE = 'https://raw.githubusercontent.com/collectioneur/readme-aura/main/examples';
|
|
9
|
-
const EXAMPLES_BROWSE_URL = 'https://github.com/collectioneur/readme-aura/tree/main/examples';
|
|
8
|
+
const EXAMPLES_RAW_BASE = 'https://raw.githubusercontent.com/collectioneur/readme-aura/main/examples/custom-templates';
|
|
9
|
+
const EXAMPLES_BROWSE_URL = 'https://github.com/collectioneur/readme-aura/tree/main/examples/custom-templates';
|
|
10
10
|
async function fileExists(path) {
|
|
11
11
|
try {
|
|
12
12
|
await access(path);
|
package/dist/init.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"init.js","sourceRoot":"","sources":["../src/init.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AACtE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,iBAAiB,EAAqB,MAAM,aAAa,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAAE,qBAAqB,EAAE,MAAM,uCAAuC,CAAC;AAC9E,OAAO,EAAE,qBAAqB,EAAE,MAAM,uCAAuC,CAAC;AAE9E,MAAM,iBAAiB,GACrB,
|
|
1
|
+
{"version":3,"file":"init.js","sourceRoot":"","sources":["../src/init.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AACtE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,iBAAiB,EAAqB,MAAM,aAAa,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAAE,qBAAqB,EAAE,MAAM,uCAAuC,CAAC;AAC9E,OAAO,EAAE,qBAAqB,EAAE,MAAM,uCAAuC,CAAC;AAE9E,MAAM,iBAAiB,GACrB,4FAA4F,CAAC;AAC/F,MAAM,mBAAmB,GACvB,kFAAkF,CAAC;AAiBrF,KAAK,UAAU,UAAU,CAAC,IAAY;IACpC,IAAI,CAAC;QACH,MAAM,MAAM,CAAC,IAAI,CAAC,CAAC;QACnB,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,SAAS,SAAS,CAAC,QAAgB,EAAE,GAAW;IAC9C,IAAI,CAAC;QACH,QAAQ,CAAC,wBAAwB,QAAQ,GAAG,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;QACxE,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,SAAS,YAAY,CAAC,GAAW;IAC/B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,QAAQ,CAAC,2BAA2B,EAAE;YACnD,GAAG;YACH,QAAQ,EAAE,OAAO;YACjB,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;SAChC,CAAC,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,iBAAiB,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED,KAAK,UAAU,oBAAoB,CAAC,IAAY;IAC9C,MAAM,GAAG,GAAG,GAAG,iBAAiB,IAAI,IAAI,mBAAmB,CAAC;IAC5D,IAAI,GAAa,CAAC;IAClB,IAAI,CAAC;QACH,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;IACzB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CACb,qDAAqD,IAAI,MAAM;YAC7D,2DAA2D,mBAAmB,EAAE,EAClF,EAAE,KAAK,EAAE,CACV,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CACb,qBAAqB,IAAI,qBAAqB,GAAG,CAAC,MAAM,MAAM;YAC5D,gCAAgC,mBAAmB,EAAE,CACxD,CAAC;IACJ,CAAC;IACD,OAAO,GAAG,CAAC,IAAI,EAAE,CAAC;AACpB,CAAC;AAED,SAAS,sBAAsB,CAAC,MAA2B;IACzD,IAAI,MAAM,IAAI,MAAM,CAAC,KAAK,KAAK,MAAM,CAAC,IAAI;QAAE,OAAO,SAAS,CAAC;IAC7D,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,KAAK,UAAU,cAAc,CAAC,GAAW;IACvC,MAAM,MAAM,GAAG;QACb,EAAE,IAAI,EAAE,4BAA4B,EAAE,IAAI,EAAE,kBAAkB,EAAE;QAChE,EAAE,IAAI,EAAE,mCAAmC,EAAE,IAAI,EAAE,qBAAqB,EAAE;QAC1E,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,YAAY,EAAE;QACzC,EAAE,IAAI,EAAE,kBAAkB,EAAE,IAAI,EAAE,mBAAmB,EAAE;KACxD,CAAC;IAEF,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,IAAI,SAAS,CAAC,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC;YAC/B,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC;IACH,CAAC;IAED,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACrB,MAAM,aAAa,GAAG,IAAI,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;QAC9C,IAAI,OAAO,GAAG,EAAE,CAAC;QACjB,IAAI,CAAC;YACH,OAAO,GAAG,MAAM,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;QACnD,CAAC;QAAC,MAAM,CAAC;YACP,mBAAmB;QACrB,CAAC;QAED,MAAM,MAAM,GACV,uDAAuD,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;QACpF,MAAM,SAAS,CAAC,aAAa,EAAE,OAAO,GAAG,MAAM,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,OAAoB,EAAE;IACtD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;IACtC,MAAM,MAAM,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;IAEjC,MAAM,SAAS,GAAG,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,CAAC;IAC/F,MAAM,QAAQ,GAAW,SAAS;QAChC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,IAAI,sBAAsB,CAAC,MAAM,CAAC,CAAC;QACnD,CAAC,CAAE,IAAI,CAAC,QAAmB,CAAC;IAE9B,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,MAAM,OAAO,GAAa,EAAE,CAAC;IAE7B,MAAM,eAAe,GAAG,mCAAmC,CAAC;IAC5D,MAAM,YAAY,GAAG,IAAI,CAAC,GAAG,EAAE,eAAe,CAAC,CAAC;IAChD,MAAM,cAAc,GAAG,MAAM,UAAU,CAAC,YAAY,CAAC,CAAC;IAEtD,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QAClC,MAAM,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,mBAAmB,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACjE,MAAM,SAAS,CAAC,YAAY,EAAE,gBAAgB,EAAE,EAAE,OAAO,CAAC,CAAC;QAC3D,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAChC,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAChC,CAAC;IAED,MAAM,aAAa,GAAG,kBAAkB,CAAC;IACzC,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;IAC5C,MAAM,YAAY,GAAG,MAAM,UAAU,CAAC,UAAU,CAAC,CAAC;IAElD,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QAChC,IAAI,OAAe,CAAC;QACpB,IAAI,SAAS,EAAE,CAAC;YACd,MAAM,GAAG,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,IAAI,eAAe,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,IAAI,WAAW,EAAE,CAAC;YAC3F,OAAO,GAAG,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC;QAC7F,CAAC;aAAM,CAAC;YACN,OAAO,GAAG,MAAM,oBAAoB,CAAC,QAAQ,CAAC,CAAC;QACjD,CAAC;QACD,MAAM,SAAS,CAAC,UAAU,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAC9C,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC9B,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC9B,CAAC;IAED,MAAM,cAAc,GAAG,MAAM,cAAc,CAAC,GAAG,CAAC,CAAC;IAEjD,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;AAChE,CAAC"}
|
package/package.json
CHANGED
package/readme.source.md
CHANGED
|
@@ -103,6 +103,42 @@
|
|
|
103
103
|
Write custom **React/JSX components** directly inside your Markdown, and readme-aura will render them into beautiful SVGs that work on GitHub.
|
|
104
104
|
|
|
105
105
|
GitHub strips all JS and CSS from README files. This tool lets you bypass that limitation by compiling your designs into static SVG images at build time.
|
|
106
|
+
<br/>
|
|
107
|
+
<br/>
|
|
108
|
+
<br/>
|
|
109
|
+
|
|
110
|
+
```aura width=260 height=60 link="https://github.com/collectioneur/readme-aura/blob/main/CONTRIBUTING.md"
|
|
111
|
+
<div style={{ display: 'flex', alignItems: 'center', gap: 0, width: '100%', height: '100%', background: 'linear-gradient(135deg, #120000, #200808)', border: '1px solid rgba(200,40,40,0.4)', borderRadius: 14, fontFamily: 'Inter, sans-serif', position: 'relative', overflow: 'hidden' }}>
|
|
112
|
+
<svg width="260" height="60" overflow="hidden" style={{ position: 'absolute', top: 0, left: 0 }}>
|
|
113
|
+
<defs>
|
|
114
|
+
<filter id="rbf" x="-100%" y="-100%" width="300%" height="300%">
|
|
115
|
+
<feGaussianBlur in="SourceGraphic" stdDeviation="10" />
|
|
116
|
+
</filter>
|
|
117
|
+
</defs>
|
|
118
|
+
<path d="M 180 30 Q 220 30 180 60 L 246 60 A 14 14 0 0 1 278 46 L 278 34 A 14 34 0 0 1 246 0 Z" fill="rgba(200,40,40,0.6)" filter="url(#rbf)" />
|
|
119
|
+
<circle cx="36" cy="30" r="4" fill="none" stroke="rgba(255,60,60,0.7)" strokeWidth="3">
|
|
120
|
+
<animate attributeName="r" values="4;28" dur="2s" repeatCount="indefinite" calcMode="linear" />
|
|
121
|
+
<animate attributeName="opacity" values="0.7;0" dur="2s" repeatCount="indefinite" calcMode="linear" />
|
|
122
|
+
</circle>
|
|
123
|
+
<circle cx="36" cy="30" r="4" fill="none" stroke="rgba(255,60,60,0.7)" strokeWidth="3">
|
|
124
|
+
<animate attributeName="r" values="4;28" dur="2s" repeatCount="indefinite" calcMode="linear" begin="0.67s" />
|
|
125
|
+
<animate attributeName="opacity" values="0.7;0" dur="2s" repeatCount="indefinite" calcMode="linear" begin="0.67s" />
|
|
126
|
+
</circle>
|
|
127
|
+
<circle cx="36" cy="30" r="4" fill="none" stroke="rgba(255,60,60,0.7)" strokeWidth="3">
|
|
128
|
+
<animate attributeName="r" values="4;28" dur="2s" repeatCount="indefinite" calcMode="linear" begin="1.33s" />
|
|
129
|
+
<animate attributeName="opacity" values="0.7;0" dur="2s" repeatCount="indefinite" calcMode="linear" begin="1.33s" />
|
|
130
|
+
</circle>
|
|
131
|
+
<circle cx="36" cy="30" r="4" fill="rgba(255,60,60,1)">
|
|
132
|
+
<animate attributeName="r" values="2.5;4;2.5" dur="1s" repeatCount="indefinite" />
|
|
133
|
+
</circle>
|
|
134
|
+
<circle cx="36" cy="30" r="3" fill="rgba(255,100,100,1)" />
|
|
135
|
+
</svg>
|
|
136
|
+
<div style={{ width: 60, flexShrink: 0 }} />
|
|
137
|
+
<span style={{ fontSize: 14, fontWeight: 700, color: '#fafafa', letterSpacing: '0.3px', zIndex: 10 }}>Built something cool? Contribute your template.</span>
|
|
138
|
+
</div>
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
Made your profile unique with readme-aura? Drop your `readme.source.md` into [`examples/custom-templates/`](https://github.com/collectioneur/readme-aura/tree/main/examples/custom-templates) and anyone will be able to install your design with a single command. See the [contributing guide](https://github.com/collectioneur/readme-aura/blob/main/CONTRIBUTING.md) for details.
|
|
106
142
|
|
|
107
143
|
## How It Works
|
|
108
144
|
|
|
@@ -211,7 +247,7 @@ npx readme-aura build
|
|
|
211
247
|
|
|
212
248
|
That's it. Push to `main` and the workflow will auto-generate your `README.md` on every push.
|
|
213
249
|
|
|
214
|
-
> `init` auto-detects profile repos (`username/username`) and picks the right template.
|
|
250
|
+
> `init` auto-detects profile repos (`username/username`) and picks the right default template.
|
|
215
251
|
|
|
216
252
|
### Commands
|
|
217
253
|
|
|
@@ -240,16 +276,15 @@ That's it. Push to `main` and the workflow will auto-generate your `README.md` o
|
|
|
240
276
|
|
|
241
277
|
### Example Templates
|
|
242
278
|
|
|
243
|
-
Pass any
|
|
279
|
+
Pass any template name from the [`examples/custom-templates/`](https://github.com/collectioneur/readme-aura/tree/main/examples/custom-templates) folder as `--template` and `init` will fetch its `readme.source.md` directly from GitHub and write it to your project:
|
|
244
280
|
|
|
245
281
|
```bash
|
|
246
282
|
npx readme-aura init --template DarkOrbs
|
|
247
283
|
npx readme-aura init --template PurpleGlow
|
|
248
284
|
npx readme-aura init --template LightOrbs
|
|
249
|
-
npx readme-aura init --template SocialMediaButton
|
|
250
285
|
```
|
|
251
286
|
|
|
252
|
-
No extra downloads, no local files needed
|
|
287
|
+
No extra downloads, no local files needed - the template is pulled on the fly and placed in `readme.source.md`, ready to build. Run `npx readme-aura build` right after and you get a working README.
|
|
253
288
|
|
|
254
289
|
## What `init` Creates
|
|
255
290
|
|
|
@@ -403,7 +438,7 @@ All parameters are written directly on the opening fence line of an `` ```aura `
|
|
|
403
438
|
| `inline` | flag | – | Render as an inline `<img>` instead of a block paragraph. Consecutive inline blocks are automatically joined on one line |
|
|
404
439
|
| `align` | `center` \| `left` \| `right` | – | Wrap a group of consecutive inline blocks in `<p align="...">`. Only meaningful when `inline` is set |
|
|
405
440
|
|
|
406
|
-
**Example
|
|
441
|
+
**Example – centered row of social buttons:**
|
|
407
442
|
|
|
408
443
|
```markdown
|
|
409
444
|
```aura width=120 height=44 link="https://github.com/you" inline align=center
|
|
@@ -421,7 +456,7 @@ Output in README.md:
|
|
|
421
456
|
</p>
|
|
422
457
|
```
|
|
423
458
|
|
|
424
|
-
> The `align` value is read from the first block in the group that declares it. Blocks without `align` still join the same group
|
|
459
|
+
> The `align` value is read from the first block in the group that declares it. Blocks without `align` still join the same group – only the wrapper is controlled by the flag.
|
|
425
460
|
|
|
426
461
|
## Components
|
|
427
462
|
|
|
@@ -470,8 +505,8 @@ readme-aura ships with ready-to-use components you can drop into any `` ```aura
|
|
|
470
505
|
|
|
471
506
|
| Prop | Default | Description |
|
|
472
507
|
|------|---------|-------------|
|
|
473
|
-
| `icon` |
|
|
474
|
-
| `text` |
|
|
508
|
+
| `icon` | – | Icon image path or URL |
|
|
509
|
+
| `text` | – | Button label |
|
|
475
510
|
| `backgroundColor` | `#111111` | Fill color |
|
|
476
511
|
| `textColor` | `#f5f5f5` | Label color |
|
|
477
512
|
| `fontSize` | `13` | Label font size |
|
|
@@ -483,7 +518,7 @@ readme-aura ships with ready-to-use components you can drop into any `` ```aura
|
|
|
483
518
|
|
|
484
519
|
## Animations
|
|
485
520
|
|
|
486
|
-
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).
|
|
521
|
+
You can add **CSS-based SVG animations** using the `<style>` injection mechanism, or **SMIL animations** (`<animate>`, `<animateTransform>`, `<animateMotion>`) directly on SVG elements. Satori renders a static frame at build time; the browser animates the SVG when it is displayed (e.g. on GitHub).
|
|
487
522
|
|
|
488
523
|
**How it works:** Add a `<style>` block in your JSX. Define `@keyframes` and apply them to elements by `#id` or `.class`. The renderer extracts and injects the CSS into the final SVG.
|
|
489
524
|
|
|
@@ -535,7 +570,7 @@ You can add **CSS-based SVG animations** using the `<style>` injection mechanism
|
|
|
535
570
|
</div>
|
|
536
571
|
```
|
|
537
572
|
|
|
538
|
-
**Limitations:** No JavaScript
|
|
573
|
+
**Limitations:** No JavaScript. GitHub strips scripts but supports both CSS animations and SMIL. Prefer `transform` and `opacity` for best CSS compatibility.
|
|
539
574
|
|
|
540
575
|
## Tech Stack
|
|
541
576
|
|