You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+79-92
Original file line number
Diff line number
Diff line change
@@ -1,37 +1,23 @@
1
1
# atweb-vue
2
-
Welcome to @web! Take a look around!
2
+
Welcome to @web!
3
3
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
5
11
*`<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.
27
12
13
+
### at:// Compatible Elements
28
14
*`<img src="[link]" />`: Images with suport for relative and at:// URIs.
29
15
*`<link>`: HTML links (e.g `link rel="stylesheet"`) with suport for relative and at:// URIs.
30
16
*`<a href="[link]">[text]</a>`: HTML anchors (hyperlinks) with support for relative and at:// URIs.
31
17
*`<Stylesheet src="[link]">`: Convenience element for linking to stylesheets, with support for relative and at:// URIs.
18
+
19
+
### Custom Elements
32
20
*`<OmitVanillaCss />`: Disables all built-in styling.
33
-
*`<style>[style]</style>`: Include your own styles in markup.
34
-
*`<title>[title]</title>`: Sets the page title.
35
21
*`<BlueskyPost src="at://did:plc:ragtjsm2j2vknwkz3zp4oxrd/app.bsky.feed.post/3kj2umze7zj2n" />`: A custom element for embedding Bluesky posts.
36
22
-`src`**Required**
37
23
AT-URI of the post record
@@ -58,101 +44,102 @@ Welcome to @web! Take a look around!
58
44
-`service-uri`**Optional**
59
45
URL to an AppView service, defaults to `https://public.api.bsky.app`
60
46
*`<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.
65
51
66
-
-`initial-tracks: { url: string; }[]`
52
+
-`initial-tracks: { url: string; }[]`**Optional**
67
53
An array of tracks to prepopulate the playlist with.
One of: `outset`, `outset-double`, `outset-invert`, `outset-double-invert`, `gloss`
113
-
-`svg: boolean`
99
+
-`svg: boolean`**Optional**
114
100
Render the badge as SVG, defaults to `false`.
115
101
*`<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.
0 commit comments