Skip to content

Commit a61a71a

Browse files
committed
Update README
1 parent 804cdbe commit a61a71a

File tree

1 file changed

+79
-92
lines changed

1 file changed

+79
-92
lines changed

README.md

+79-92
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,23 @@
11
# atweb-vue
2-
Welcome to @web! Take a look around!
2+
Welcome to @web!
33

4-
### Custom Elements
4+
@web lets you host your own static sites on the AT Protocol. It's like [Neocities](https://neocities.org/) or [Nekoweb](https://nekoweb.org/), but on a PDS!
5+
6+
### Functional Elements
7+
* `<style>[style]</style>`: Include your own styles in markup.
8+
* `<title>[title]</title>`: Sets the page title.
9+
10+
### Custom Markup Elements
511
* `<blink>[text]</blink>`: Blinking text.
6-
* `<hr />`: A styled horizontal rule.
7-
* `<h1>[text]</h1>`: A styled heading (size 1).
8-
* `<h2>[text]</h2>`: A styled heading (size 2).
9-
* `<h3>[text]</h3>`: A styled heading (size 3).
10-
* `<h4>[text]</h4>`: A styled heading (size 4).
11-
* `<h5>[text]</h5>`: A styled heading (size 5).
12-
* `<h6>[text]</h6>`: A styled heading (size 6).
13-
* `<ol>[text]</ol>`: A styled ordered list.
14-
* `<ul>[text]</ul>`: A styled unordered list.
15-
* `<p>[text]</p>`: A styled paragraph.
16-
* `<blockquote>[text]</blockquote>`: A styled "blockquote" element.
17-
* `<uppercase>[text]</uppercase>`: Renders text inside it as uppercase.
18-
* `<lowercase>[text]</lowercase>`: Renders text inside it as lowercase.
19-
* `<capitalize>[text]</capitalize>`: Capitalizes text inside it.
20-
* `<highlighted>[text]</highlighted>`: Highlights text inside it.
21-
* `<left>[text]</left>`: Aligns text inside it to the left.
22-
* `<right>[text]</right>`: Aligns text inside it to the right.
23-
* `<center>[text]</center>`: Aligns text inside it to the center.
24-
* `<justify>[text]</justify>`: Justifies text inside it.
25-
* `<truncate>[text]</truncate>`: Truncates text inside it.
26-
* `<no-wrap>[text]</no-wrap>`: Disables text wrapping inside it.
2712

13+
### at:// Compatible Elements
2814
* `<img src="[link]" />`: Images with suport for relative and at:// URIs.
2915
* `<link>`: HTML links (e.g `link rel="stylesheet"`) with suport for relative and at:// URIs.
3016
* `<a href="[link]">[text]</a>`: HTML anchors (hyperlinks) with support for relative and at:// URIs.
3117
* `<Stylesheet src="[link]">`: Convenience element for linking to stylesheets, with support for relative and at:// URIs.
18+
19+
### Custom Elements
3220
* `<OmitVanillaCss />`: Disables all built-in styling.
33-
* `<style>[style]</style>`: Include your own styles in markup.
34-
* `<title>[title]</title>`: Sets the page title.
3521
* `<BlueskyPost src="at://did:plc:ragtjsm2j2vknwkz3zp4oxrd/app.bsky.feed.post/3kj2umze7zj2n" />`: A custom element for embedding Bluesky posts.
3622
- `src` **Required**
3723
AT-URI of the post record
@@ -58,101 +44,102 @@ Welcome to @web! Take a look around!
5844
- `service-uri` **Optional**
5945
URL to an AppView service, defaults to `https://public.api.bsky.app`
6046
* `<Webamp />`: Embed Webamp in your webpage!
61-
- `initial-skin: { url: string }`
62-
An object representing the initial skin to use.
63-
If omitted, the default skin, included in the bundle, will be used.
64-
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.
6551

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

69-
- `available-skins: { url: string; name: string }[]`
70-
An array of objects representing available skins.
71-
These will appear in the "Options" menu under "Skins".
72-
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.
7359
Example: `[ { url: "./green.wsz", name: "Green Dimension V2" } ]`
7460

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

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

85-
- `enable-hotkeys: boolean`
86-
Should global hotkeys be enabled?
71+
- `enable-hotkeys: boolean` **Optional**
72+
Should global hotkeys be enabled?
8773
Default: `false`
8874

8975
- `z-index: number`
9076
* `<Spotify />`: Embedded Spotify player.
91-
- `uri: string`
92-
Spotify song URI or ID to play.
93-
- `width: number`
94-
Player width, optional.
95-
- `height: number`
96-
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.
9783
* `<Oneko />`: cat follow mouse, real
98-
- `cat: string`
99-
Replace the cat.
100-
- `pettable: boolean`
101-
Is the cat pettable? Defaults to `true`.
102-
- `scrolls: boolean`
103-
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`.
10490
* `<LesbiBadge />`: Include a badge from [badge.les.bi](https://badge.les.bi/).
105-
- `clip: string`
91+
- `clip: string` **Required**
10692
One of: `half`, `75-degree`, `45-degree`, `diagonal`, `75-degree-alt`, `45-degree-alt`, `diagonal-alt`, `bottom-half`, `diamond`, `heart`, `heart-split`, `star`, `triangle`
10793

108-
- `flag1: string`, `flag2: string`
94+
- `flag1: string`, `flag2: string` **Required**
10995
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`
11096

111-
- `overlay: string`
97+
- `overlay: string` **Required**
11298
One of: `outset`, `outset-double`, `outset-invert`, `outset-double-invert`, `gloss`
113-
- `svg: boolean`
99+
- `svg: boolean` **Optional**
114100
Render the badge as SVG, defaults to `false`.
115101
* `<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.
116102
* `<Userbar />`: Generate custom userbars!
117-
- `width: number` **Optional**
118-
The userbar width.
119-
- `height: number` **Optional**
120-
The userbar height.
121-
- `text: string` **Optional**
122-
The userbar text.
123-
- `textColor: string` **Optional**
124-
The text color, in CSS format.
125-
126-
- `background-type: "gradient" | "plain"` **Optional**
127-
The
128-
- `background-position-x: number` **Required if background-type is set**
129-
- `background-position-y: number` **Required if background-type is set**
130-
- `background-end-position-x: number` **Required if background-type is set**
131-
- `background-end-position-y: number` **Required if background-type is set**
132-
- `background-color: string` or `background-colors: string[]` **Required if background-type is set**
133-
The background color (or colors, for gradients), in CSS format.
134-
135-
- `textAlign: "left" | "center" | "right"` **Optional**
136-
The userbar text's alignment.
137-
- `textBorder: boolean` **Optional**
138-
Add a border to the userbar text?
139-
- `textBorderWidth: number` **Optional**
140-
The border width, if set.
141-
- `textBorderColor: string` **Optional**
142-
The border color, if set.
143-
- `pattern: "none" | "dots" | "stripes"` **Optional**
144-
The pattern.
145-
- `topShadow: boolean` **Optional**
146-
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?
147133
* `<RingLink>[text]</RingLink>`: Adds left/right links to members of an @ring.
148-
- `direction: 'previous' | 'next'` **Optional**
149-
The direction the link is going. Defaults to 'previous'.
150-
- `ringUri: string` **Required**
151-
The at:// URI to the @ring.
152-
- `self: string` **Required**
153-
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.
154140

155141
### Reversible File Path Record Key Specification
142+
_(for nerds)_
156143

157144
Converting file path to Record Key:
158145

0 commit comments

Comments
 (0)