michael/astro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Astro Types for docs: capitalize Markdown (#3912)

Browse source 
- 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"
This commit is contained in:
Sarah Rainsberger 2022-07-13 18:02:06 -03:00 committed by GitHub
parent fa8ec57f16
commit aa2ac87881
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
packages/astro/src/@types/astro.ts
View file

@ -498,9 +498,9 @@ export interface AstroUserConfig {
* @type {boolean} * @type {boolean}
* @default `false` * @default `false`
* @description * @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 * ```js
* { * {
@ -519,9 +519,9 @@ export interface AstroUserConfig {
* @type {'md' | 'mdx'} * @type {'md' | 'mdx'}
* @default `mdx` * @default `mdx`
* @description * @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 * ```js
* { * {
@ -539,7 +539,7 @@ export interface AstroUserConfig {
* @name markdown.shikiConfig * @name markdown.shikiConfig
* @typeraw {Partial<ShikiConfig>} * @typeraw {Partial<ShikiConfig>}
* @description * @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>; shikiConfig?: Partial<ShikiConfig>;