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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: use github-slugger for markdown anchors #16067

Merged
merged 3 commits into from Jul 2, 2022

Conversation

harish-sethuraman
Copy link
Member

@harish-sethuraman harish-sethuraman commented Jun 29, 2022

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

[x] Documentation update
[x] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)

Making use of slugify function from old site

reference:

Is there anything you'd like reviewers to focus on?

There is one another slugger library

that we add as filter in eleventy and have used it inside only one file

The problem here is that this library Coerces foreign symbols to their English equivalent link for more details. so the problems & statements is turned into problems-and-statements and added inside id. How ever I don't see this id being referenced anywhere. If it is not referenced anywhere (please help confirm this) we can go ahead and remove slugify library. 馃槃

@eslint-github-bot eslint-github-bot bot added triage An ESLint team member will look at this issue soon bug ESLint is working incorrectly labels Jun 29, 2022
@netlify
Copy link

@netlify netlify bot commented Jun 29, 2022

Deploy Preview for docs-eslint ready!

Name Link
馃敤 Latest commit e2afad6
馃攳 Latest deploy log https://app.netlify.com/sites/docs-eslint/deploys/62bd2b4b8aeacf0008427f31
馃槑 Deploy Preview https://deploy-preview-16067--docs-eslint.netlify.app
馃摫 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@mdjermanovic mdjermanovic changed the title [new docs site] fix: use github-slugger for markdown anchors chore: use github-slugger for markdown anchors Jun 29, 2022
@mdjermanovic mdjermanovic added documentation Relates to ESLint's documentation accepted There is consensus among the team that this change meets the criteria for inclusion chore This change is not user-facing and removed bug ESLint is working incorrectly triage An ESLint team member will look at this issue soon labels Jun 29, 2022
@mdjermanovic mdjermanovic mentioned this pull request Jun 29, 2022
1 task
@mdjermanovic
Copy link
Member

@mdjermanovic mdjermanovic commented Jun 29, 2022

How ever I don't see this id being referenced anywhere.

I don't think these sections are referenced from other pages, and even if they are, it's more likely that those links are still using IDs from the old website.

@harish-sethuraman
Copy link
Member Author

@harish-sethuraman harish-sethuraman commented Jun 29, 2022

it's more likely that those links are still using IDs from the old website.

I ran the old archive-website and noticed that the symbols weren't transformed <h2 id="layout-formatting">Layout &amp; Formatting</h2> but now they are layout-and-formatting. The only place this is being used is inside the TOC for that page. Shall we leave it as such? or should we remove that library and replace its slug method as well?

@mdjermanovic
Copy link
Member

@mdjermanovic mdjermanovic commented Jun 29, 2022

I think for consistency it would be good that IDs are always generated the same way, so this should be id="layout-formatting".

@harish-sethuraman
Copy link
Member Author

@harish-sethuraman harish-sethuraman commented Jun 29, 2022

So I tried to replace with github-slugger instead of slugify but seems like github-slugger produces layout--formatting with that same implementation as archive-website. Seems like the older site didn't use that (github-slugger) implementation as well. It was using anchor-js so we might want to replace -- with - in the new docs site while adding anchors (through slugify filters). Thoughts?

@mdjermanovic
Copy link
Member

@mdjermanovic mdjermanovic commented Jun 29, 2022

If there's already id on the element, anchor-js uses that id, so most ids were generated by github-slugger. But these particular headers on the old rules page apparently didn't have ids, so anchor-js assigned them ids per its own slugger. Since that's the case, I think it isn't important to retain the exact same ids, and layout--formatting looks good to me if that's what github-slugger produces.

Copy link
Member

@mdjermanovic mdjermanovic left a comment

LGTM, thanks!

I'll leave this open in case someone else wants to review it before merging.

docs/.eleventy.js Outdated Show resolved Hide resolved
nzakas
nzakas approved these changes Jul 2, 2022
Copy link
Member

@nzakas nzakas left a comment

LGTM. Thanks.

@nzakas nzakas merged commit e884933 into eslint:main Jul 2, 2022
20 checks passed
crapStone pushed a commit to Calciumdibromid/CaBr2 that referenced this issue Jul 4, 2022
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [eslint](https://eslint.org) ([source](https://github.com/eslint/eslint)) | devDependencies | minor | [`8.18.0` -> `8.19.0`](https://renovatebot.com/diffs/npm/eslint/8.18.0/8.19.0) |

---

### Release Notes

<details>
<summary>eslint/eslint</summary>

### [`v8.19.0`](https://github.com/eslint/eslint/releases/tag/v8.19.0)

[Compare Source](eslint/eslint@v8.18.0...v8.19.0)

#### Features

-   [`7023628`](eslint/eslint@7023628) feat: add importNames support for patterns in no-restricted-imports ([#&#8203;16059](eslint/eslint#16059)) (Brandon Scott)
-   [`472c368`](eslint/eslint@472c368) feat: fix handling of blockless `with` statements in indent rule ([#&#8203;16068](eslint/eslint#16068)) (Milos Djermanovic)

#### Bug Fixes

-   [`fc81848`](eslint/eslint@fc81848) fix: throw helpful exception when rule has wrong return type ([#&#8203;16075](eslint/eslint#16075)) (Bryan Mishkin)

#### Documentation

-   [`3ae0574`](eslint/eslint@3ae0574) docs: Remove duplicate rule descriptions ([#&#8203;16052](eslint/eslint#16052)) (Amaresh  S M)
-   [`f50cf43`](eslint/eslint@f50cf43) docs: Add base href to each page to fix relative URLs ([#&#8203;16046](eslint/eslint#16046)) (Nicholas C. Zakas)
-   [`ae4b449`](eslint/eslint@ae4b449) docs: make logo link clickable on small width screens ([#&#8203;16058](eslint/eslint#16058)) (Milos Djermanovic)
-   [`280f898`](eslint/eslint@280f898) docs: use only fenced code blocks ([#&#8203;16044](eslint/eslint#16044)) (Milos Djermanovic)
-   [`f5d63b9`](eslint/eslint@f5d63b9) docs: add listener only if element exists ([#&#8203;16045](eslint/eslint#16045)) (Amaresh  S M)
-   [`8b639cc`](eslint/eslint@8b639cc) docs: add missing migrating-to-8.0.0 in the user guide ([#&#8203;16048](eslint/eslint#16048)) (鍞劧)
-   [`b8e68c1`](eslint/eslint@b8e68c1) docs: Update release process ([#&#8203;16036](eslint/eslint#16036)) (Nicholas C. Zakas)
-   [`6d0cb11`](eslint/eslint@6d0cb11) docs: remove table of contents from markdown text ([#&#8203;15999](eslint/eslint#15999)) (Nitin Kumar)

#### Chores

-   [`e884933`](eslint/eslint@e884933) chore: use `github-slugger` for markdown anchors ([#&#8203;16067](eslint/eslint#16067)) (Strek)
-   [`02e9cb0`](eslint/eslint@02e9cb0) chore: revamp carbon ad style ([#&#8203;16078](eslint/eslint#16078)) (Amaresh  S M)
-   [`b6aee95`](eslint/eslint@b6aee95) chore: remove unwanted comments from rules markdown ([#&#8203;16054](eslint/eslint#16054)) (Strek)
-   [`6840940`](eslint/eslint@6840940) chore: correctly use .markdownlintignore in Makefile ([#&#8203;16060](eslint/eslint#16060)) (Bryan Mishkin)
-   [`48904fb`](eslint/eslint@48904fb) chore: add missing images ([#&#8203;16017](eslint/eslint#16017)) (Amaresh  S M)
-   [`910f741`](eslint/eslint@910f741) chore: add architecture to nav ([#&#8203;16039](eslint/eslint#16039)) (Strek)
-   [`9bb24c1`](eslint/eslint@9bb24c1) chore: add correct incorrect in all rules doc ([#&#8203;16021](eslint/eslint#16021)) (Deepshika S)
-   [`5a96af8`](eslint/eslint@5a96af8) chore: prepare versions data file ([#&#8203;16035](eslint/eslint#16035)) (Nicholas C. Zakas)
-   [`50afe6f`](eslint/eslint@50afe6f) chore: Included githubactions in the dependabot config ([#&#8203;15985](eslint/eslint#15985)) (Naveen)
-   [`473411e`](eslint/eslint@473411e) chore: add deploy workflow for playground ([#&#8203;16034](eslint/eslint#16034)) (Milos Djermanovic)
-   [`a30b66c`](eslint/eslint@a30b66c) chore: fix print style ([#&#8203;16025](eslint/eslint#16025)) (Amaresh  S M)
-   [`f4dad59`](eslint/eslint@f4dad59) chore: add noindex meta tag ([#&#8203;16016](eslint/eslint#16016)) (Milos Djermanovic)
-   [`db387a8`](eslint/eslint@db387a8) chore: fix sitemap ([#&#8203;16026](eslint/eslint#16026)) (Milos Djermanovic)
-   [`285fbc5`](eslint/eslint@285fbc5) chore: remove TOC from printable ([#&#8203;16020](eslint/eslint#16020)) (Strek)
-   [`8e84c21`](eslint/eslint@8e84c21) chore: remove ligatures from fonts ([#&#8203;16019](eslint/eslint#16019)) (Strek)

</details>

---

### Configuration

馃搮 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

馃殾 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

 **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

馃敃 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, click this checkbox.

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

Co-authored-by: cabr2-bot <cabr2.help@gmail.com>
Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1444
Reviewed-by: 6543 <6543@noreply.codeberg.org>
Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion chore This change is not user-facing documentation Relates to ESLint's documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants