summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Sarah Rainsberger <sarah@rainsberger.ca> 2022-07-13 18:02:06 -0300
committerGravatar GitHub <noreply@github.com> 2022-07-13 16:02:06 -0500
commitaa2ac8788144f53ddd99ea4b80a4c82bf3059a40 (patch)
treefdf7f6fe59625c4298f7aa89bd7289310760efbf
parentfa8ec57f16a970e642e69eeeba425a1affd05189 (diff)
downloadastro-aa2ac8788144f53ddd99ea4b80a4c82bf3059a40.tar.gz
astro-aa2ac8788144f53ddd99ea4b80a4c82bf3059a40.tar.zst
astro-aa2ac8788144f53ddd99ea4b80a4c82bf3059a40.zip
Astro Types for docs: capitalize Markdown (#3912)
- Capitalizes a few errant "markdowns" that find their way into Docs. - Also updates "if or not" to "whether or not" since I'm here. - Also, admittedly a point of contention, but until we decide otherwise for the entire site: a straggling "front matter" -> "frontmatter"
-rw-r--r--packages/astro/src/@types/astro.ts10
1 files changed, 5 insertions, 5 deletions
diff --git a/packages/astro/src/@types/astro.ts b/packages/astro/src/@types/astro.ts
index 78ba9e301..766ee0607 100644
--- a/packages/astro/src/@types/astro.ts
+++ b/packages/astro/src/@types/astro.ts
@@ -498,9 +498,9 @@ export interface AstroUserConfig {
* @type {boolean}
* @default `false`
* @description
- * Control if markdown draft pages should be included in the build.
+ * Control whether Markdown draft pages should be included in the build.
*
- * A markdown page is considered a draft if it includes `draft: true` in its front matter. Draft pages are always included & visible during development (`astro dev`) but by default they will not be included in your final build.
+ * A Markdown page is considered a draft if it includes `draft: true` in its frontmatter. Draft pages are always included & visible during development (`astro dev`) but by default they will not be included in your final build.
*
* ```js
* {
@@ -519,9 +519,9 @@ export interface AstroUserConfig {
* @type {'md' | 'mdx'}
* @default `mdx`
* @description
- * Control if markdown processing is done using MDX or not.
+ * Control whether Markdown processing is done using MDX or not.
*
- * MDX processing enables you to use JSX inside your Markdown files. However, there may be instances where you don't want this behavior, and would rather use a "vanilla" markdown processor. This field allows you to control that behavior.
+ * MDX processing enables you to use JSX inside your Markdown files. However, there may be instances where you don't want this behavior, and would rather use a "vanilla" Markdown processor. This field allows you to control that behavior.
*
* ```js
* {
@@ -539,7 +539,7 @@ export interface AstroUserConfig {
* @name markdown.shikiConfig
* @typeraw {Partial<ShikiConfig>}
* @description
- * Shiki configuration options. See [the markdown configuration docs](https://docs.astro.build/en/guides/markdown-content/#shiki-configuration) for usage.
+ * Shiki configuration options. See [the Markdown configuration docs](https://docs.astro.build/en/guides/markdown-content/#shiki-configuration) for usage.
*/
shikiConfig?: Partial<ShikiConfig>;