Skip to content

Commit

Permalink
Use over <br> after all
Browse files Browse the repository at this point in the history
`<br>` seems to prevent the Markdown parsing the text block as a paragraph resulting in weird stuff. `  ` at line ends works, so using that after all.
  • Loading branch information
delucis committed Mar 12, 2022
1 parent 4b7574e commit b8c75dc
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion scripts/docgen.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ export async function run() {
cliFlag ? `**CLI:** \`${cliFlag.text}\`` : undefined,
comment.defaultvalue ? `**Default:** ${comment.defaultvalue}` : undefined,
comment.version ? `<Since v="${comment.version}" />` : undefined
].filter(l => l !== undefined).join('<br>\n'),
].filter(l => l !== undefined).join(' \n'),
``,
comment.description && comment.description.trim(),
comment.see ? `**See Also:**\n${comment.see.map(s => `- ${s}`.trim()).join('\n')}` : undefined,
Expand Down
26 changes: 13 additions & 13 deletions src/pages/en/reference/configuration-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ export default /** @type {import('astro').AstroUserConfig} */ ({

### projectRoot

**Type:** `string`<br>
**CLI:** `--project-root`<br>
**Type:** `string`
**CLI:** `--project-root`
**Default:** `"."` (current working directory)

You should only provide this option if you run the `astro` CLI commands in a directory other than the project root directory. Usually, this option is provided via the CLI instead of the `astro.config.js` file, since Astro needs to know your project root before it can locate your config file.
Expand All @@ -53,7 +53,7 @@ $ astro build --project-root ./my-project-directory

### dist

**Type:** `string`<br>
**Type:** `string`
**Default:** `"./dist"`

Set the directory that `astro build` writes your final build to.
Expand All @@ -69,7 +69,7 @@ The value can be either an absolute file system path or a path relative to the p

### public

**Type:** `string`<br>
**Type:** `string`
**Default:** `"./public"`

Set the directory for your static assets. Files in this directory are served at `/` during dev and copied to your build directory during build. These files are always served or copied as-is, without transform or bundling.
Expand All @@ -85,7 +85,7 @@ The value can be either an absolute file system path or a path relative to the p

### renderers

**Type:** `Array.<string>`<br>
**Type:** `Array.<string>`
**Default:** `['@astrojs/renderer-svelte','@astrojs/renderer-vue','@astrojs/renderer-react','@astrojs/renderer-preact']`

Set the UI framework renderers for your project. Framework renderers are what power Astro's ability to use other frameworks inside of your project, like React, Svelte, and Vue.
Expand Down Expand Up @@ -149,7 +149,7 @@ Astro will match the site pathname during development so that your development e

### sitemap

**Type:** `boolean`<br>
**Type:** `boolean`
**Default:** `true`

Generate a sitemap for your build. Set to false to disable.
Expand Down Expand Up @@ -190,7 +190,7 @@ Return `true` to include a page in your sitemap, and `false` to remove it.

### pageUrlFormat

**Type:** `'file' | 'directory'`<br>
**Type:** `'file' | 'directory'`
**Default:** `'directory'`

Control the output file format of each page.
Expand All @@ -209,7 +209,7 @@ Control the output file format of each page.

### drafts

**Type:** `boolean`<br>
**Type:** `boolean`
**Default:** `false`

Control if markdown draft pages should be included in the build.
Expand All @@ -230,8 +230,8 @@ A markdown page is considered a draft if it includes `draft: true` in its front

### host

**Type:** `string | boolean`<br>
**Default:** `false`<br>
**Type:** `string | boolean`
**Default:** `false`
<Since v="0.24.0" />

Set which network IP addresses the dev server should listen on (i.e. non-localhost IPs).
Expand All @@ -242,7 +242,7 @@ Set which network IP addresses the dev server should listen on (i.e. non-localh

### hostname

**Type:** `string`<br>
**Type:** `string`
**Default:** `'localhost'`

> **This option is deprecated.** Consider using `host` instead.
Expand All @@ -252,7 +252,7 @@ Set which IP addresses the dev server should listen on. Set this to 0.0.0.0 to l

### port

**Type:** `number`<br>
**Type:** `number`
**Default:** `3000`

Set which port the dev server should listen on.
Expand All @@ -262,7 +262,7 @@ If the given port is already in use, Astro will automatically try the next avail

### trailingSlash

**Type:** `'always' | 'never' | 'ignore'`<br>
**Type:** `'always' | 'never' | 'ignore'`
**Default:** `'always'`

Set the route matching behavior of the dev server. Choose from the following options:
Expand Down

0 comments on commit b8c75dc

Please sign in to comment.