Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: vuejs/vitepress
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: v1.0.0-alpha.43
Choose a base ref
...
head repository: vuejs/vitepress
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: v1.0.0-alpha.44
Choose a head ref
  • 7 commits
  • 16 files changed
  • 6 contributors

Commits on Jan 29, 2023

  1. Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
    Copy the full SHA
    010b3e5 View commit details
  2. Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
    Copy the full SHA
    1f77577 View commit details

Commits on Jan 30, 2023

  1. Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
    Copy the full SHA
    abe62fd View commit details

Commits on Jan 31, 2023

  1. docs: editorial fixes (#1866)

    Co-authored-by: Kia King Ishii <kia.king.08@gmail.com>
    xfq and kiaking authored Jan 31, 2023

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
    Copy the full SHA
    9f25534 View commit details
  2. Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
    Copy the full SHA
    8f7d35f View commit details
  3. fix(theme): infer collapsible from collapsed (#1865)

    BREAKING CHANGE: `collapsible` is dropped from sidebar, use `collapsed` instead
    brc-dd authored Jan 31, 2023

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
    Copy the full SHA
    dea6cfa View commit details
  4. release: v1.0.0-alpha.44

    brc-dd committed Jan 31, 2023

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
    Copy the full SHA
    893bfd2 View commit details
2 changes: 1 addition & 1 deletion .github/workflows/release-tag.yml
Original file line number Diff line number Diff line change
@@ -21,4 +21,4 @@ jobs:
with:
tag_name: ${{ github.ref }}
body: |
Please refer to [CHANGELOG.md](https://github.com/vuejs/vitepress/blob/main/CHANGELOG.md) for details.
Please refer to [CHANGELOG.md](https://github.com/${{ github.repository }}/blob/main/CHANGELOG.md) for details.
20 changes: 20 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,23 @@
# [1.0.0-alpha.44](https://github.com/vuejs/vitepress/compare/v1.0.0-alpha.43...v1.0.0-alpha.44) (2023-01-31)


### Bug Fixes

* take `<a>` in SVG into account ([#1850](https://github.com/vuejs/vitepress/issues/1850)) ([010b3e5](https://github.com/vuejs/vitepress/commit/010b3e5ad99f5e61fd01e27d0c3144896a8f3d86))
* **theme:** infer collapsible from collapsed ([#1865](https://github.com/vuejs/vitepress/issues/1865)) ([dea6cfa](https://github.com/vuejs/vitepress/commit/dea6cfa9cbccf4c6433295e80571acee9b260f71))


### Features

* **theme:** preconnect algolia when idle ([#1851](https://github.com/vuejs/vitepress/issues/1851)) ([1f77577](https://github.com/vuejs/vitepress/commit/1f775774da7ef51ae8e690bbd86f94c739611a65))


### BREAKING CHANGES

* **theme:** `collapsible` is dropped from sidebar, use `collapsed` instead



# [1.0.0-alpha.43](https://github.com/vuejs/vitepress/compare/v1.0.0-alpha.42...v1.0.0-alpha.43) (2023-01-29)


2 changes: 1 addition & 1 deletion __tests__/e2e/.vitepress/config.ts
Original file line number Diff line number Diff line change
@@ -4,7 +4,7 @@ const sidebar: DefaultTheme.Config['sidebar'] = {
'/': [
{
text: 'Frontmatter',
collapsible: true,
collapsed: false,
items: [
{
text: 'Multiple Levels Outline',
8 changes: 4 additions & 4 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
@@ -79,7 +79,7 @@ function sidebarGuide() {
return [
{
text: 'Introduction',
collapsible: true,
collapsed: false,
items: [
{ text: 'What is VitePress?', link: '/guide/what-is-vitepress' },
{ text: 'Getting Started', link: '/guide/getting-started' },
@@ -91,7 +91,7 @@ function sidebarGuide() {
},
{
text: 'Writing',
collapsible: true,
collapsed: false,
items: [
{ text: 'Markdown', link: '/guide/markdown' },
{ text: 'Asset Handling', link: '/guide/asset-handling' },
@@ -102,7 +102,7 @@ function sidebarGuide() {
},
{
text: 'Theme',
collapsible: true,
collapsed: false,
items: [
{ text: 'Introduction', link: '/guide/theme-introduction' },
{ text: 'Nav', link: '/guide/theme-nav' },
@@ -121,7 +121,7 @@ function sidebarGuide() {
},
{
text: 'Migrations',
collapsible: true,
collapsed: false,
items: [
{
text: 'Migration from VuePress',
11 changes: 3 additions & 8 deletions docs/config/theme-configs.md
Original file line number Diff line number Diff line change
@@ -147,16 +147,11 @@ export type SidebarItem = {
items?: SidebarItem[]

/**
* If `true`, toggle button is shown.
* If not specified, group is not collapsible.
*
* @default false
*/
collapsible?: boolean

/**
* If `true`, collapsible group is collapsed by default.
* If `true`, group is collapsible and collapsed by default
*
* @default false
* If `false`, group is collapsible but expanded by default
*/
collapsed?: boolean
}
4 changes: 2 additions & 2 deletions docs/guide/api.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# API Reference

VitePress offers several built in API to let you access app data. VitePress also comes with few built-in component that can be used globally.
VitePress offers several built-in APIs to let you access app data. VitePress also comes with a few built-in components that can be used globally.

The helper methods are globally importable from `vitepress` and are typically used in custom theme Vue components. However, they are also usable inside `.md` pages because markdown files are compiled into Vue single-file components.
The helper methods are globally importable from `vitepress` and are typically used in custom theme Vue components. However, they are also usable inside `.md` pages because markdown files are compiled into Vue [Single-File Components](https://vuejs.org/guide/scaling-up/sfc.html).

Methods that start with `use*` indicates that it is a [Vue 3 Composition API](https://vuejs.org/guide/introduction.html#composition-api) function that can only be used inside `setup()` or `<script setup>`.

2 changes: 1 addition & 1 deletion docs/guide/routing.md
Original file line number Diff line number Diff line change
@@ -21,7 +21,7 @@ Then you can access the pages by the below URL.
index.md -> /
prologue.md -> /prologue.html
guide/index.md -> /guide/
getting-started.md -> /guide/getting-started.html
guide/getting-started.md -> /guide/getting-started.html
```

As you can see, the directory structure corresponds to the final URL, as same as hosting plain HTML from a typical web server.
10 changes: 2 additions & 8 deletions docs/guide/theme-sidebar.md
Original file line number Diff line number Diff line change
@@ -149,20 +149,15 @@ export default {

## Collapsible Sidebar Groups

By adding `collapsible` option to the sidebar group, it shows a toggle button to hide/show each section.
By adding `collapsed` option to the sidebar group, it shows a toggle button to hide/show each section.

```js
export default {
themeConfig: {
sidebar: [
{
text: 'Section Title A',
collapsible: true,
items: [...]
},
{
text: 'Section Title B',
collapsible: true,
collapsed: false,
items: [...]
}
]
@@ -178,7 +173,6 @@ export default {
sidebar: [
{
text: 'Section Title A',
collapsible: true,
collapsed: true,
items: [...]
}
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "vitepress",
"version": "1.0.0-alpha.43",
"version": "1.0.0-alpha.44",
"description": "Vite & Vue powered static site generator",
"type": "module",
"packageManager": "pnpm@7.26.1",
@@ -84,9 +84,9 @@
"@docsearch/js": "^3.3.2",
"@vitejs/plugin-vue": "^4.0.0",
"@vue/devtools-api": "^6.5.0",
"@vueuse/core": "^9.11.1",
"@vueuse/core": "^9.12.0",
"body-scroll-lock": "4.0.0-beta.0",
"shiki": "^0.13.0",
"shiki": "^0.14.0",
"vite": "^4.0.4",
"vue": "^3.2.45"
},
@@ -160,7 +160,7 @@
"simple-git-hooks": "^2.8.1",
"sirv": "^2.0.2",
"supports-color": "^9.3.1",
"typescript": "~4.9.4",
"typescript": "~4.9.5",
"vitest": "^0.28.3",
"vue-tsc": "^1.0.24",
"wait-on": "^7.0.1"
76 changes: 40 additions & 36 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading