Skip to content

Commit

Permalink
Update README formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanhefner committed Nov 30, 2023
1 parent d73e8c1 commit deb4f46
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,16 +113,16 @@ const ExamplePage = () => (
## Properties
| Props | Description |
| Prop | Description |
|---------------------------------|-----------------------------------------------|
| `audioUrl?: string` | URL to audio file. |
| `audioType?: string` | Mimetype of audio file. |
| `baseUrl?: string` | Used specify base url to use for all `xUrl` props, allowing you to simply pass in `url="/about"` vs. `url="https://yourdomain.com/about"`. | `debug?: boolean` | Currently not used, but things are in the works.|
| `description?: string` | You know, `<meta name="description" content="You know, a description" />` |
| `determiner?: string` | The word that appears before this object's title in a sentence.An enum of (a, an, the, "", auto). If `auto` is chosen, the consumer of your data should chose between "a" or "an". Default is "" (blank). |
| `imageUrl?: string` | URL to image. |
| `imageWidth?: number | string` | Width of the image. (Typically: `1200px`) |
| `imageHeight?: number | string` | Height of the image. (Typically: `630px`) |
| `imageWidth?: number \| string` | Width of the image. (Typically: `1200px`) |
| `imageHeight?: number \| string` | Height of the image. (Typically: `630px`) |
| `locale?: string` | Locale of site/page |
| `siteName?: string` | Use for `og:site_name` and appended to `<title>` |
| `title?: string` | Title of page. Generates: `<title>` + `og:title` + `twitter:title` tags |
Expand Down

0 comments on commit deb4f46

Please sign in to comment.