msb-public
/
vitepress
mirror of https://github.com/vuejs/vitepress
2
1
Code Issues Projects Releases Wiki Activity

feat(build): provide a `pathname://` protocol to escape SPA (#1719)

Browse Source
pull/1721/head
Sam Estep 2 years ago committed by GitHub
parent a5e408fd3b
commit ae21a3a622
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 22 additions and 3 deletions
Show Stats Download Patch File Download Diff File

5
docs/guide/asset-handling.md
Unescape View File

@ -22,6 +22,11 @@ Assets placed in `public` will be copied to the root of the dist directory as-is
Note that you should reference files placed in `public` using root absolute path - for example, `public/icon.png` should always be referenced in source code as `/icon.png`. Note that you should reference files placed in `public` using root absolute path - for example, `public/icon.png` should always be referenced in source code as `/icon.png`.
There is one exception to this: if you have an HTML page in `public` and link to it from the main site, the router will yield a 404 by default. To get around this, VitePress provides a `pathname://` protocol which allows you to link to another page in the same domain as if the link is external. Contrast these two links:
- [/pure.html](/pure.html)
- <pathname:///pure.html>
## Base URL ## Base URL
If your site is deployed to a non-root URL, you will need to set the `base` option in `.vitepress/config.js`. For example, if you plan to deploy your site to `https://foo.github.io/bar/`, then `base` should be set to `'/bar/'` (it should always start and end with a slash). If your site is deployed to a non-root URL, you will need to set the `base` option in `.vitepress/config.js`. For example, if you plan to deploy your site to `https://foo.github.io/bar/`, then `base` should be set to `'/bar/'` (it should always start and end with a slash).

12
docs/public/pure.html
Unescape View File

@ -0,0 +1,12 @@
<!DOCTYPE html>
<html>
<head>
<title>Plain HTML page | VitePress</title>
<meta charset="utf-8" />
<meta name="robots" content="noindex, nofollow" />
</head>
<body>
<h1>Not part of the main VitePress docs site</h1>
<div>This page is plain HTML in the <code>public</code> directory.</div>
</body>
</html>

4
src/client/theme-default/support/utils.ts
Unescape View File

@ -1,6 +1,6 @@
import { ref } from 'vue' import { ref } from 'vue'
import { withBase, useData } from 'vitepress' import { withBase, useData } from 'vitepress'
import { EXTERNAL_URL_RE } from '../../shared.js' import { EXTERNAL_URL_RE, PATHNAME_PROTOCOL_RE } from '../../shared.js'
export const HASH_RE = /#.*$/ export const HASH_RE = /#.*$/
export const EXT_RE = /(index)?\.(md|html)$/ export const EXT_RE = /(index)?\.(md|html)$/
@ -71,7 +71,7 @@ export function normalize(path: string): string {
export function normalizeLink(url: string): string { export function normalizeLink(url: string): string {
if (isExternal(url)) { if (isExternal(url)) {
return url return url.replace(PATHNAME_PROTOCOL_RE, '')
} }
const { site } = useData() const { site } = useData()

3
src/node/markdown/plugins/link.ts
Unescape View File

@ -5,7 +5,7 @@
import MarkdownIt from 'markdown-it' import MarkdownIt from 'markdown-it'
import type { MarkdownEnv } from '../env' import type { MarkdownEnv } from '../env'
import { URL } from 'url' import { URL } from 'url'
import { EXTERNAL_URL_RE } from '../../shared' import { EXTERNAL_URL_RE, PATHNAME_PROTOCOL_RE } from '../../shared'
const indexRE = /(^|.*\/)index.md(#?.*)$/i const indexRE = /(^|.*\/)index.md(#?.*)$/i
@ -35,6 +35,7 @@ export const linkPlugin = (
if (url.replace(EXTERNAL_URL_RE, '').startsWith('//localhost:')) { if (url.replace(EXTERNAL_URL_RE, '').startsWith('//localhost:')) {
pushLink(url, env) pushLink(url, env)
} }
hrefAttr[1] = url.replace(PATHNAME_PROTOCOL_RE, '')
} else if ( } else if (
// internal anchor links // internal anchor links
!url.startsWith('#') && !url.startsWith('#') &&

1
src/shared/shared.ts
Unescape View File

@ -18,6 +18,7 @@ export type {
} from '../../types/shared.js' } from '../../types/shared.js'
export const EXTERNAL_URL_RE = /^[a-z]+:/i export const EXTERNAL_URL_RE = /^[a-z]+:/i
export const PATHNAME_PROTOCOL_RE = /^pathname:\/\//
export const APPEARANCE_KEY = 'vitepress-theme-appearance' export const APPEARANCE_KEY = 'vitepress-theme-appearance'
export const inBrowser = typeof window !== 'undefined' export const inBrowser = typeof window !== 'undefined'

Write Preview
Loading…
Cancel
Save