https://github.com/vuepress/vuepress-plugin-clean-urls

:droplet: Use clean urls in VuePress.
https://github.com/vuepress/vuepress-plugin-clean-urls

Last synced: 5 days ago
JSON representation

:droplet: Use clean urls in VuePress.

• Host: GitHub
• URL: https://github.com/vuepress/vuepress-plugin-clean-urls
• Owner: vuepress
• License: mit
• Archived: true
• Created: 2019-03-15T03:13:08.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-11-07T07:48:54.000Z (about 5 years ago)
• Last Synced: 2024-08-01T12:32:20.788Z (3 months ago)
• Language: JavaScript
• Homepage: https://vuepress.github.io/plugins/clean-urls.html
• Size: 72.3 KB
• Stars: 6
• Watchers: 1
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - vuepress/vuepress-plugin-clean-urls - :droplet: Use clean urls in VuePress. (others)

README

        
# [vuepress-plugin-clean-urls](https://vuepress.github.io/plugins/clean-urls.html)

> Migrated to [vuepress-community](https://github.com/vuepress/vuepress-community)

[![npm](https://img.shields.io/npm/v/vuepress-plugin-clean-urls.svg)](https://www.npmjs.com/package/vuepress-plugin-clean-urls)

A [VuePress](https://vuepress.vuejs.org/) plugin that provides support for clean urls.

## Caveats

This plugin will always work on your dev server, but VuePress **does not have the right** to modify server identification. If you want your URLs to follow a certain pattern (e.g. `/routing` instead of `/routing.html` or `routing/`), you should make sure that your server would treat it as an HTML. This means that you may need to configure your server specifically.

**References:**

- For Netify users: [https://www.netlify.com/docs/redirects/#trailing-slash](https://www.netlify.com/docs/redirects/#trailing-slash).

- For Surge users: [https://surge.sh/help/using-clean-urls-automatically](https://surge.sh/help/using-clean-urls-automatically).

## Options

### normalSuffix

- **type:** `string`

- **default:** `''`

The suffix for normal pages. For example, `foo/bar.md` will become:

- `foo/bar.html` by default (without this plugin)

- `foo/bar/` (with `normalSuffix` set to `'/'`)

- `foo/bar` (with `normalSuffix` set to `''`)

### indexSuffix

- **type:** `string`

- **default:** `'/'`

The suffix for index pages. For example, `foo/index.md` will become:

- `foo/` by default (without this plugin)

- `foo` (with `indexSuffix` set to `''`)

- `foo/index.html` (with `indexSuffix` set to `'/index.html'`)

**tip:** An index page is a page with a file name of `index.md` or `readme.md` (case insensitive).

### notFoundPath

- **type:** `string`

- **default:** `'/404.html'`

URL for "404 not found" page.

## Contribution

Contribution Welcome!