Skip to content

Commit

Permalink
docs: πŸ“ update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kwaa committed Dec 15, 2023
1 parent c164d72 commit 21acc27
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs/intro/showcase.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The "FFF-compatible" project showcase.

If your project is FFF compatible, please let me know!

## SSG / Static Site Generator
## SSG (Static Site Generator)

### [Lume](https://github.com/lumeland/lume) <Badge type="warning" text="official" /> <Badge type="danger" text="experimental" />

Expand Down
25 changes: 19 additions & 6 deletions docs/version/1.2.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ For more on object media, see [Concepts: Object Media](/concepts/object-media)
### image

- type: `string`
- optional type: [`FFFImage`](#additional)
- optional type: [`FFFImage`](#fffimage)
- jsonfeed: `image` (string only)
- description: the main image for article or photo[^photo] post.
- microformats: `u-photo` or `u-featured`[^featured]
Expand All @@ -156,7 +156,7 @@ image:
### images

- type: `string[]`
- optional type: [`FFFImage[]`](#additional)
- optional type: [`FFFImage[]`](#fffimage)
- jsonfeed: `image` (string and first only)
- microformats: `u-photo`
- description: the images for multi-photo[^multi-photo] post.
Expand Down Expand Up @@ -184,7 +184,7 @@ images:
### audio

- type: `string`
- optional type: [`FFFAudio`](#additional)
- optional type: [`FFFAudio`](#fffaudio)
- microformats: `u-audio`[^audio]
- description: the main audio for audio post.

Expand All @@ -201,7 +201,7 @@ audio:
### video

- type: `string`
- optional type: [`FFFVideo`](#additional)
- optional type: [`FFFVideo`](#fffvideo)
- microformats: `u-video`[^video] or `u-featured`[^featured]
- description: the main video for video post.

Expand Down Expand Up @@ -284,7 +284,7 @@ This means that its naming is tentative and only used as a suggestion if needed.

### authors

- type: [`FFFAuthor[]`](#additional)
- type: [`FFFAuthor[]`](#fffauthor)
- jsonfeed: `authors`
- description: specifies one or more post authors.

Expand Down Expand Up @@ -360,7 +360,7 @@ rsvp: 'interested'

## Types

### Additional
### FFFImage

```ts
/** Object Image */
Expand All @@ -369,16 +369,29 @@ export type FFFImage = Partial<HTMLImageElement> & {
figcaption?: string
}
```

### FFFAudio

```ts
/** Object Audio */
export type FFFAudio = Partial<HTMLAudioElement> & {
sources?: Partial<HTMLSourceElement>[]
}
```

### FFFVideo

```ts
/** Object Video */
export type FFFVideo = Partial<HTMLVideoElement> & {
sources?: Partial<HTMLSourceElement>[]
}
```

### FFFAuthor

```ts
/** Author */
export type FFFAuthor = {
/** the author's name. */
Expand Down

0 comments on commit 21acc27

Please sign in to comment.