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

[new docs site] Remove table of contents from markdown text #15997

Closed
Tracked by #117
nzakas opened this issue Jun 13, 2022 · 2 comments · Fixed by #15999
Closed
Tracked by #117

[new docs site] Remove table of contents from markdown text #15997

nzakas opened this issue Jun 13, 2022 · 2 comments · Fixed by #15999
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion bug ESLint is working incorrectly documentation Relates to ESLint's documentation good first issue Good for people who haven't worked on ESLint before
Projects

Comments

@nzakas
Copy link
Member

nzakas commented Jun 13, 2022

On each page with a table of contents under the header, the last couple of items in the table of contents are not styled correctly. This happened within the last few days, so it's likely that there's a recent pull request that caused this problem.

Example:
https://new.eslint.org/docs/head/user-guide/configuring/rules

Screenshot:
Screenshot 2022-06-13 at 11-09-46 Rules

Notes

The documentation site lives in /docs of this repo. You can cd into that directly, run npm install to install the dependencies and npm start to run locally.

@nzakas nzakas added bug ESLint is working incorrectly documentation Relates to ESLint's documentation accepted There is consensus among the team that this change meets the criteria for inclusion labels Jun 13, 2022
@eslint-github-bot eslint-github-bot bot added this to Needs Triage in Triage Jun 13, 2022
@nzakas nzakas moved this from Needs Triage to Ready to Implement in Triage Jun 13, 2022
@nzakas nzakas added the good first issue Good for people who haven't worked on ESLint before label Jun 13, 2022
@mdjermanovic
Copy link
Member

On each page with a table of contents under the header, the last couple of items in the table of contents are not styled correctly.

By the last couple of items that are not styled correctly, did you mean this?

image

This is table of contents we manually added to this document:

* [Configuring Rules](#configuring-rules)
* [Disabling Rules](#disabling-rules)

For the new site, we should probably just remove it?

@nzakas
Copy link
Member Author

nzakas commented Jun 14, 2022

Yes that’s it. I didn’t even think we had added that manually. Yes, we should remove it from the markdown text.

@mdjermanovic mdjermanovic changed the title Docs: Table of contents rendering bug [new docs site] Remove table of contents from markdown text Jun 16, 2022
Triage automation moved this from Ready to Implement to Complete Jun 21, 2022
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Dec 19, 2022
@eslint-github-bot eslint-github-bot bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Dec 19, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion bug ESLint is working incorrectly documentation Relates to ESLint's documentation good first issue Good for people who haven't worked on ESLint before
Projects
Archived in project
Triage
Complete
Development

Successfully merging a pull request may close this issue.

2 participants