Skip to content

Commit

Permalink
docs: update config params doc
Browse files Browse the repository at this point in the history
  • Loading branch information
yamankatby committed Nov 29, 2022
1 parent 92fd892 commit c2da175
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions docs/pages/generate-og-image/config-params.mdx
Original file line number Diff line number Diff line change
@@ -1,49 +1,49 @@
# Configurable parameters

### Location
## Location

Where do you want to deploy the functions created for this extension? For help selecting a location, refer to the [location selection guide](https://firebase.google.com/docs/functions/locations).

### Template
## Template

The [handlebars](https://handlebarsjs.com/) template to use for generating the image. The template must be either a raw HTML string or a URL to a public HTML file.

If you want to store the templates in a Cloud Firestore collection, leave this field empty and set the `TEMPLATES_COLLECTION` parameter instead.

### Templates collection
## Templates collection

The path to the Cloud Firestore collection that contains the templates to use for generating the images. The collection must have a document for each template, where the document ID is the template name and the document contains a `template` field with the template string.

If you want to use a static template, leave this field empty and set the `TEMPLATE` parameter instead.

### Markdown params
## Markdown params

A comma-separated list of query parameters that contain Markdown-formatted text. The extension will convert the Markdown to HTML before rendering the template.

Leave this field empty if you don't want to use Markdown.

### Emoji provider
## Emoji provider

The style of emojis to use in the generated images.

- `twemoji` uses [Twemoji](https://twemoji.twitter.com/) emojis.

### Width
## Width

The width of the generated image in pixels.

### Height
## Height

The height of the generated image in pixels.

### Format
## Format

The format of the generated image.

### Cache-Control header
## Cache-Control header

The value of the `Cache-Control` header to set on the generated images.

### Cloud Function memory
## Cloud Function memory

The amount of memory to allocate to the Cloud Function.

1 comment on commit c2da175

@vercel
Copy link

@vercel vercel bot commented on c2da175 Dec 9, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.