Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: fixes links with badges in the tables of content #3438

Merged
merged 1 commit into from Jul 4, 2022

Conversation

artplan1
Copy link
Contributor

@artplan1 artplan1 commented Jul 2, 2022

Fixes #3224

It's caused by long-standing issue in vuepress + markdown-it-table-of-contents: vuejs/vuepress#1985

PR vuejs/vuepress#2210 might fix it, but it's abandoned

@changeset-bot
Copy link

changeset-bot bot commented Jul 2, 2022

⚠️ No Changeset found

Latest commit: efef92c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@codesandbox-ci
Copy link

codesandbox-ci bot commented Jul 2, 2022

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit efef92c:

Sandbox Source
XState Example Template Configuration
XState React Template Configuration

@ghost
Copy link

ghost commented Jul 2, 2022

👇 Click on the image for a new way to code review
  • Make big changes easier — review code in small groups of related files

  • Know where to start — see the whole change at a glance

  • Take a code tour — explore the change with an interactive tour

  • Make comments and review — all fully sync’ed with github

    Try it now!

Review these changes using an interactive CodeSee Map

Legend

CodeSee Map Legend

@@ -1,3 +1,11 @@
const { slugify } = require('@vuepress/shared-utils');
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's in dependencies of vuepress, no need to import it explicitly

@@ -20,7 +28,7 @@ module.exports = {
}
},
markdown: {
toc: { includeLevel: [2, 3] }
toc: { includeLevel: [2, 3], slugify: slugifyWithBadges }
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

includeLevel is by default [2, 3] in vuepress, this can be removed

@Andarist Andarist merged commit 22d85ad into statelyai:main Jul 4, 2022
@artplan1 artplan1 deleted the artplan1/docs-toc-badges branch July 4, 2022 15:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: Anchors with version numbers in docs don't work
3 participants