Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix typo in code comments #11944

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fix typo in code comments #11944

wants to merge 1 commit into from

Conversation

motss
Copy link

@motss motss commented Sep 7, 2024

Changes

The following changes should update this page in the documentation.

  1. fix type of security from boolean to object
  2. fix default value of security.checkOrigin to use backticks (`) instead of '
  3. fix example of inlneStylesheets to use ' instead of backtick (`never` -> 'never')
  4. fix default value of image.domains from { domains: [] } to []
  5. add missing whitespace in objects

Testing

The changes updates the documentation only.

Docs

The change updates the documentation.

Copy link

changeset-bot bot commented Sep 7, 2024

⚠️ No Changeset found

Latest commit: 3f1194f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions github-actions bot added pkg: astro Related to the core `astro` package (scope) docs pr labels Sep 7, 2024
@@ -1106,7 +1106,7 @@ export interface AstroUserConfig {
*
* ```js
* {
* server: { port: 1234, host: true}
* server: { port: 1234, host: true }
Copy link
Author

Choose a reason for hiding this comment

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

NOTE: add missing whitespace

@@ -1447,7 +1448,7 @@ export interface AstroUserConfig {
* import remarkToc from 'remark-toc';
* {
* markdown: {
* remarkPlugins: [ [remarkToc, { heading: "contents"} ] ]
* remarkPlugins: [ [remarkToc, { heading: "contents" }] ]
Copy link
Author

Choose a reason for hiding this comment

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

NOTE: add missing whitespace

@@ -1517,7 +1518,7 @@ export interface AstroUserConfig {
* {
* markdown: {
* // Example: Translate the footnotes text to another language, here are the default English values
* remarkRehype: { footnoteLabel: "Footnotes", footnoteBackLabel: "Back to reference 1"},
* remarkRehype: { footnoteLabel: "Footnotes", footnoteBackLabel: "Back to reference 1" },
Copy link
Author

Choose a reason for hiding this comment

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

NOTE: add missing whitespace

@motss motss marked this pull request as ready for review September 7, 2024 19:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs pr pkg: astro Related to the core `astro` package (scope)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants