Skip to content

Commit 804cdbe

Browse files
spearcatspearcat
committed
Update index.mdx
1 parent 8c49816 commit 804cdbe

File tree

1 file changed

+67
-67
lines changed

1 file changed

+67
-67
lines changed

Diff for: ‎src/pages/index.mdx

+67-67
Original file line numberDiff line numberDiff line change
@@ -44,99 +44,99 @@ Welcome to @web!
4444
- `service-uri` **Optional**
4545
URL to an AppView service, defaults to `https://public.api.bsky.app`
4646
* `<Webamp />`: Embed Webamp in your webpage!
47-
- `initial-skin: { url: string }`
48-
An object representing the initial skin to use.
49-
If omitted, the default skin, included in the bundle, will be used.
50-
Note: This URL must be served the with correct CORS headers.
47+
- `initial-skin: { url: string }` **Optional**
48+
An object representing the initial skin to use.
49+
If omitted, the default skin, included in the bundle, will be used.
50+
Note: This URL must be served the with correct CORS headers.
5151

52-
- `initial-tracks: { url: string; }[]`
52+
- `initial-tracks: { url: string; }[]` **Optional**
5353
An array of tracks to prepopulate the playlist with.
5454

55-
- `available-skins: { url: string; name: string }[]`
56-
An array of objects representing available skins.
57-
These will appear in the "Options" menu under "Skins".
58-
Note: These URLs must be served with the correct CORS headers.
55+
- `available-skins: { url: string; name: string }[]` **Optional**
56+
An array of objects representing available skins.
57+
These will appear in the "Options" menu under "Skins".
58+
Note: These URLs must be served with the correct CORS headers.
5959
Example: `[ { url: "./green.wsz", name: "Green Dimension V2" } ]`
6060

61-
- `window-layout: WindowLayout`
61+
- `window-layout: WindowLayout` **Optional**
6262
Configure how the Winamp windows should be laid out on initial render.
6363

64-
- `enable-double-size-mode: boolean`
64+
- `enable-double-size-mode: boolean` **Optional**
6565
Controls if "double size mode", where the fixed sized windows are rendered
66-
at 2x, should be enabled
66+
at 2x, should be enabled
6767
**Note:** In keeping with the original Winamp, double size mode does not
68-
apply to resizable windows like the equalizer or Milkdrop.
68+
apply to resizable windows like the equalizer or Milkdrop.
6969
Default: `false`
7070

71-
- `enable-hotkeys: boolean`
72-
Should global hotkeys be enabled?
71+
- `enable-hotkeys: boolean` **Optional**
72+
Should global hotkeys be enabled?
7373
Default: `false`
7474

7575
- `z-index: number`
7676
* `<Spotify />`: Embedded Spotify player.
77-
- `uri: string`
78-
Spotify song URI or ID to play.
79-
- `width: number`
80-
Player width, optional.
81-
- `height: number`
82-
Player height, optional.
77+
- `uri: string` **Required**
78+
Spotify song URI or ID to play.
79+
- `width: number` **Optional**
80+
Player width.
81+
- `height: number` **Optional**
82+
Player height.
8383
* `<Oneko />`: cat follow mouse, real
84-
- `cat: string`
85-
Replace the cat.
86-
- `pettable: boolean`
87-
Is the cat pettable? Defaults to `true`.
88-
- `scrolls: boolean`
89-
Does scrolling move the cat? Defaults to `true`.
84+
- `cat: string` **Optional**
85+
Replace the cat.
86+
- `pettable: boolean` **Optional**
87+
Is the cat pettable? Defaults to `true`.
88+
- `scrolls: boolean` **Optional**
89+
Does scrolling move the cat? Defaults to `true`.
9090
* `<LesbiBadge />`: Include a badge from [badge.les.bi](https://badge.les.bi/).
91-
- `clip: string`
91+
- `clip: string` **Required**
9292
One of: `half`, `75-degree`, `45-degree`, `diagonal`, `75-degree-alt`, `45-degree-alt`, `diagonal-alt`, `bottom-half`, `diamond`, `heart`, `heart-split`, `star`, `triangle`
9393

94-
- `flag1: string`, `flag2: string`
94+
- `flag1: string`, `flag2: string` **Required**
9595
One of: `trans`, `lesbi`, `enby`, `bi`, `rainbow`, `lesbi-7`, `gay`, `gay-7`, `agender`, `fluid`, `intersex`, `intersex-double`, `ace`, `aro`, `aroace`, `neptunic`, `genderfae`, `pan`, `polysexual`, `demi`, `genderqueer`, `poly`
9696

97-
- `overlay: string`
97+
- `overlay: string` **Required**
9898
One of: `outset`, `outset-double`, `outset-invert`, `outset-double-invert`, `gloss`
99-
- `svg: boolean`
99+
- `svg: boolean` **Optional**
100100
Render the badge as SVG, defaults to `false`.
101101
* `<Badge name="[name]" />`: Add any badge from [here](https://github.com/atweb-vue/atweb-vue.github.io/tree/main/src/assets/badges) to your page, by simply including the file name and extension.
102102
* `<Userbar />`: Generate custom userbars!
103-
- `width: number` **Optional**
104-
The userbar width.
105-
- `height: number` **Optional**
106-
The userbar height.
107-
- `text: string` **Optional**
108-
The userbar text.
109-
- `textColor: string` **Optional**
110-
The text color, in CSS format.
111-
112-
- `background-type: "gradient" | "plain"` **Optional**
113-
The
114-
- `background-position-x: number` **Required if background-type is set**
115-
- `background-position-y: number` **Required if background-type is set**
116-
- `background-end-position-x: number` **Required if background-type is set**
117-
- `background-end-position-y: number` **Required if background-type is set**
118-
- `background-color: string` or `background-colors: string[]` **Required if background-type is set**
119-
The background color (or colors, for gradients), in CSS format.
120-
121-
- `textAlign: "left" | "center" | "right"` **Optional**
122-
The userbar text's alignment.
123-
- `textBorder: boolean` **Optional**
124-
Add a border to the userbar text?
125-
- `textBorderWidth: number` **Optional**
126-
The border width, if set.
127-
- `textBorderColor: string` **Optional**
128-
The border color, if set.
129-
- `pattern: "none" | "dots" | "stripes"` **Optional**
130-
The pattern.
131-
- `topShadow: boolean` **Optional**
132-
Add a top shadow?
103+
- `width: number` **Optional**
104+
The userbar width.
105+
- `height: number` **Optional**
106+
The userbar height.
107+
- `text: string` **Optional**
108+
The userbar text.
109+
- `textColor: string` **Optional**
110+
The text color, in CSS format.
111+
112+
- `background-type: "gradient" | "plain"` **Optional**
113+
The background type.
114+
- `background-position-x: number` **Required if background-type is set**
115+
- `background-position-y: number` **Required if background-type is set**
116+
- `background-end-position-x: number` **Required if background-type is set**
117+
- `background-end-position-y: number` **Required if background-type is set**
118+
- `background-color: string` or `background-colors: string[]` **Required if background-type is set**
119+
The background color (or colors, for gradients), in CSS format.
120+
121+
- `textAlign: "left" | "center" | "right"` **Optional**
122+
The userbar text's alignment.
123+
- `textBorder: boolean` **Optional**
124+
Add a border to the userbar text?
125+
- `textBorderWidth: number` **Optional**
126+
The border width, if set.
127+
- `textBorderColor: string` **Optional**
128+
The border color, if set.
129+
- `pattern: "none" | "dots" | "stripes"` **Optional**
130+
The pattern.
131+
- `topShadow: boolean` **Optional**
132+
Add a top shadow?
133133
* `<RingLink>[text]</RingLink>`: Adds left/right links to members of an @ring.
134-
- `direction: 'previous' | 'next'` **Optional**
135-
The direction the link is going. Defaults to 'previous'.
136-
- `ringUri: string` **Required**
137-
The at:// URI to the @ring.
138-
- `self: string` **Required**
139-
Your DID.
134+
- `direction: 'previous' | 'next'` **Optional**
135+
The direction the link is going. Defaults to 'previous'.
136+
- `ringUri: string` **Required**
137+
The at:// URI to the @ring.
138+
- `self: string` **Required**
139+
Your DID.
140140

141141
### Reversible File Path Record Key Specification
142142
_(for nerds)_

0 commit comments

Comments
 (0)