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

Add remark-flexible-toc to list of plugins #1339

Merged
merged 1 commit into from
Jun 24, 2024
Merged

Add remark-flexible-toc to list of plugins #1339

merged 1 commit into from
Jun 24, 2024

Conversation

talatkuyuk
Copy link
Contributor

@talatkuyuk talatkuyuk commented Jun 21, 2024

Initial checklist

  • I read the support docs
  • I read the contributing guide
  • I agree to follow the code of conduct
  • I searched issues and couldn’t find anything (or linked relevant results below)
  • If applicable, I’ve added docs and tests

Description of changes

Added a new plugin remark-flexible-toc to list of plugins

https://github.com/ipikuka/remark-flexible-toc
https://www.npmjs.com/package/remark-flexible-toc

It is remark plugin to expose the table of contents via Vfile.data or via an option reference in markdown/MDX.

The remark-flexible-toc exposes the table of contents (TOC) in two ways:

  • by adding the toc key into the Vfile.data
  • by mutating a reference array if provided in the options

Developers who are interested in easily creating a TOC with remark-flexible-toc can look at the applications below, where you will see an example of <TableOfContentComponent /> component.

@github-actions github-actions bot added 👋 phase/new Post is being triaged automatically 🤞 phase/open Post is being triaged manually and removed 👋 phase/new Post is being triaged automatically labels Jun 21, 2024
Copy link
Member

@remcohaszing remcohaszing left a comment

Choose a reason for hiding this comment

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

Thanks!

One little detail: The unified import will end up in your type definitions. Therefor unified should be a dependency, not dev dependency.

@talatkuyuk
Copy link
Contributor Author

Thanks @remcohaszing for the advice. unified has been moved to dependencies part.

https://github.com/ipikuka/remark-flexible-toc/releases

@wooorm wooorm merged commit bd1c556 into remarkjs:main Jun 24, 2024
4 checks passed
@wooorm wooorm added 📚 area/docs This affects documentation 💪 phase/solved Post is done labels Jun 24, 2024
@wooorm
Copy link
Member

wooorm commented Jun 24, 2024

Thanks Talat! :)

This comment has been minimized.

@github-actions github-actions bot removed the 🤞 phase/open Post is being triaged manually label Jun 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 area/docs This affects documentation 💪 phase/solved Post is done
Development

Successfully merging this pull request may close these issues.

3 participants