Feat(toc): Introduce #5399

AugustinMauroy · 2023-05-24T13:43:59Z

Description

Migration of table of contents from nodejs.dev but using nextra TOC

Related Issues

#5242

Check List

I have read the Contributing Guidelines and made commit messages that follow the guideline.
I have run npx turbo lint to ensure the code follows the style guide. And run npx turbo lint:fix to fix the style errors if necessary.
I have run npx turbo format to ensure the code follows the style guide.
I have run npx turbo test to check if all tests are passing, and/or npx turbo test:snapshot to update snapshots if I created and/or updated React Components.
I've covered new added functionality with unit tests if necessary.

vercel · 2023-05-24T13:44:04Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
nodejs-org	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 4, 2023 0:00am
nodejs-org-stories	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 4, 2023 0:00am

vercel · 2023-05-24T13:44:05Z

@AugustinMauroy is attempting to deploy a commit to the OpenJS Foundation Team on Vercel.

A member of the Team first needs to authorize it.

AugustinMauroy · 2023-05-24T13:44:46Z

i will rebase/cherrypick to fix everything don't worry

Co-authored-by: Manish Kumar ⛄ <[email protected]> Co-authored-by: Wai.Tung <[email protected]> Co-authored-by: Shanmughapriyan S <[email protected]> Co-authored-by: Michael Esteban <[email protected]> Co-authored-by: Claudio Wunder <[email protected]> Co-authored-by: Teja Sai Sandeep Reddy Konala <[email protected]> Co-authored-by: Claudio Wunder <[email protected]> Co-authored-by: vasanth9 <cheepurupalli.vasanthkumar.com> Co-authored-by: Aymen Naghmouchi <[email protected]> Co-authored-by: Teja Sai Sandeep Reddy Konala <[email protected]> Co-authored-by: Augustin Mauroy <[email protected]> Co-authored-by: Guilherme Araújo <[email protected]> Co-authored-by: Augustin Mauroy <[email protected]> Co-authored-by: HinataKah0 <[email protected]> Co-authored-by: Olaleye Blessing <[email protected]> Co-authored-by: ktssr <[email protected]> Co-authored-by: vasanthkumar <[email protected]> Co-authored-by: Floran Hachez <[email protected]> Co-authored-by: Jatin <[email protected]> fixed styleling misconfig and fixed storybooks (#5281) fix storybook styles, imports, typescript config and dependencies (#5319 fix(package.json) Lint command is missing slashes (#5321 fix storybook local development mode (#5335) fix(i18n): translation key (#5347)

Co-authored-by: Harkunwar Kochar <[email protected]> Signed-off-by: Augustin Mauroy <[email protected]>

Co-authored-by: Shanmughapriyan S <[email protected]> Signed-off-by: Augustin Mauroy <[email protected]>

* feat: Add MUI Config and Theme Provider * added createTheme * refactor themeConfig * feat(theme): Fix linting and package-lock * feat(theme): Add emotion styled and emtion react --------- Co-authored-by: Harkunwar Kochar <[email protected]>

* feat: create codebox component * feat: add pointer to copy button * feat: add shell support * feat: use code element instead of pre * chore: fix eslint issues * refactor: remove shell codebox * refactor: use react.fc type * refactor: remove duplicate encoding * refactor: use pre element for codebox * style: some eol * style: some eol * refactor: use pre element for codebox * chore: create inlinecode story * refactor: create inline code story type * chore: revert .browserslistrc * test: remove duplicated test * test: remove beginning space on code * refactor: setup userEvent on tests * refactor: remove useless async * test: manual mock isomorphic-dompurify * fix: some fixes * chore: create multi lang story * test: snapshot before and after switch lang * refactor: inline mock * refactor: use decorators * chore: split inlinecode component * feat: add selected lang state * refactor: add inlinecode decorator * refactor: remove duplicate classes * chore: revert .browserslistrc * test: fix tests * chore: wip * feat: use story component arg * style: stories * test: remove i18n from clipboard test * chore: migrate pagination component (#5331) Co-authored-by: Teja Sai Sandeep Reddy Konala <[email protected]> Co-authored-by: Claudio Wunder <[email protected]> Co-authored-by: Wai.Tung <[email protected]> * chore: add a proper decorated component * refactor: decorated inline code * Chore(node feat) (#5338) Co-authored-by: Claudio Wunder <[email protected]> * (website redesign) Feat(shellbox): migration (#5234) Co-authored-by: Manish Kumar ⛄ <[email protected]> Co-authored-by: Claudio Wunder <[email protected]> Co-authored-by: Shanmughapriyan S <[email protected]> Co-authored-by: Michael Esteban <[email protected]> Co-authored-by: Wai.Tung <[email protected]> * fix(i18n): translation key (#5347) Co-authored-by: Shanmughapriyan S <[email protected]> Co-authored-by: Claudio Wunder <[email protected]> * feat: add hover states * chore: fix rebase leftovers * chore: update snapshots * chore: install @types/prismjs * Update index.stories.tsx Signed-off-by: Claudio Wunder <[email protected]> * chore: remove duplicate snapshots * chore: remove duplicate snapshot --------- Signed-off-by: Claudio Wunder <[email protected]> Co-authored-by: ktssr <[email protected]> Co-authored-by: Teja Sai Sandeep Reddy Konala <[email protected]> Co-authored-by: Claudio Wunder <[email protected]> Co-authored-by: Wai.Tung <[email protected]> Co-authored-by: Claudio Wunder <[email protected]> Co-authored-by: Augustin Mauroy <[email protected]> Co-authored-by: Manish Kumar ⛄ <[email protected]> Co-authored-by: Shanmughapriyan S <[email protected]> Co-authored-by: Michael Esteban <[email protected]>

* feat: introduce built-in next.js exports and updated scripts and configs (#5384) * chore: updated gitignore and rmeoved robots.txt * chore: updated next-sitemap config * chore: next-config refactored options and export support * chore: updated imports to node: prefix * chore: updated contributing guidelines * chore: updated scripts * chore: updated next-sitemap * chore: added missing props * fix: github-pages * chore: remove unused package * fix(storybook): update packages (#5386) --------- Co-authored-by: Harkunwar Kochar <[email protected]>

Co-Authored-By: Michael Esteban <[email protected]>

AugustinMauroy · 2023-05-25T19:13:25Z

Rebase done !

ovflowd

I appreciate the effort and work done here. But the current state of the PR is far from something we can ship in this repository.

I left some feedback, but I would rather not giving code examples ad I want you to think by yourself (this time) and be able to achieve something useful without the constant need of mentoring.

components/Article/TableOfContents/index.tsx

Signed-off-by: Augustin Mauroy <[email protected]>

ovflowd · 2023-07-02T20:24:50Z

@AugustinMauroy this PR #5467 introduces the feature that actually will support headings metadata so you can create the ToC.

This is the overall shape of the Headings:

[
  {"depth": 1, "value": "Heading 1", "data": {"id": "custom-id"}},
  {"depth": 2, "value": "Heading 2"},
  {"depth": 3, "value": "Heading 3"},
]

And the type of Heading is also exported by @vcarl/remark-headings. So now you can adopt the approach we mentioned with the CSS and simple loops.

AugustinMauroy · 2023-07-04T11:31:20Z

@ovflowd What types of data ?

ovflowd · 2023-07-04T12:36:50Z

public/node-releases-data.json

@@ -1 +1 @@
-[]


Please do not commit these files.

Run npm ci to install husky.

ovflowd · 2023-07-04T12:37:28Z

@ovflowd What types of data ?

Could you rephrase your question? I have no idea what you're referring to/talking about.

ovflowd · 2023-07-04T12:38:03Z

__fixtures__/page.ts

Why is the name of this fixture page?

ovflowd · 2023-07-04T12:38:37Z

components/Article/TableOfContents/index.module.scss

+
+    li {
+
+      // not use for now


Please remove this commented code 😅

ovflowd · 2023-07-04T12:38:53Z

components/Article/TableOfContents/index.module.scss

+      &.depth2 {
+        list-style-type: square;
+        margin-left: var(--space-08);
+      }


Empty line between each other statement... 👀

bmuenzenmeyer · 2023-07-15T11:32:23Z

@AugustinMauroy this PR and a couple other ones seem to be stagnating. Do you want help driving them toward completion?

AugustinMauroy requested a review from a team as a code owner May 24, 2023 13:44

vercel bot temporarily deployed to Preview – nodejs-org-stories May 25, 2023 19:00 Inactive

vercel bot temporarily deployed to Preview – nodejs-org May 25, 2023 19:01 Inactive

Harkunwar and others added 14 commits May 25, 2023 21:01

feat(TOC):introduce component

fa60fb5

feat(TOC): match with nextra TOC

702c6f6

feat(TOC): update snapshot

4192059

Update components/Article/TableOfContents/index.tsx

6e9f8a9

Co-authored-by: Harkunwar Kochar <[email protected]> Signed-off-by: Augustin Mauroy <[email protected]>

feat(TOC): Add nested list

78243d9

better typing + fix typo

256353a

simplify the logic

0730e23

Update components/Article/TableOfContents/index.tsx

139e586

Co-authored-by: Shanmughapriyan S <[email protected]> Signed-off-by: Augustin Mauroy <[email protected]>

feat(stability): migrate component (#5339)

53c261c

feat(TOC): add typing

8592879

Co-Authored-By: Michael Esteban <[email protected]>

vercel bot temporarily deployed to Preview – nodejs-org-stories May 25, 2023 19:03 Inactive

vercel bot temporarily deployed to Preview – nodejs-org May 25, 2023 19:04 Inactive

fix: rebase

7355240

vercel bot temporarily deployed to Preview – nodejs-org-stories May 25, 2023 19:11 Inactive

vercel bot temporarily deployed to Preview – nodejs-org-stories May 25, 2023 19:12 Inactive

vercel bot temporarily deployed to Preview – nodejs-org May 25, 2023 19:14 Inactive

ovflowd requested changes Jun 14, 2023

View reviewed changes

components/Article/TableOfContents/index.tsx Outdated Show resolved Hide resolved

Merge branch 'main' into feat(TOC)

da67367

Signed-off-by: Augustin Mauroy <[email protected]>

vercel bot temporarily deployed to Preview – nodejs-org-stories June 22, 2023 08:24 Inactive

Merge branch 'main' into feat(TOC)

8d5b109

vercel bot temporarily deployed to Preview – nodejs-org June 29, 2023 21:35 Inactive

vercel bot temporarily deployed to Preview – nodejs-org-stories June 29, 2023 21:35 Inactive

ovflowd added website redesign Issue/PR part of the Node.js Website Redesign feature-request labels Jul 2, 2023

AugustinMauroy marked this pull request as draft July 3, 2023 11:01

Merge remote-tracking branch 'upstream/main' into feat(TOC)

7e2fd2d

vercel bot temporarily deployed to Preview – nodejs-org-stories July 4, 2023 11:27 Inactive

vercel bot temporarily deployed to Preview – nodejs-org July 4, 2023 11:28 Inactive

update

fb56c1c

AugustinMauroy marked this pull request as ready for review July 4, 2023 11:58

vercel bot temporarily deployed to Preview – nodejs-org-stories July 4, 2023 11:58 Inactive

vercel bot temporarily deployed to Preview – nodejs-org July 4, 2023 12:00 Inactive

ovflowd reviewed Jul 4, 2023

View reviewed changes

__fixtures__/page.ts

Copy link

Member

ovflowd Jul 4, 2023

Choose a reason for hiding this comment

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

Why is the name of this fixture page?

ovflowd reviewed Jul 4, 2023

View reviewed changes

components/Article/TableOfContents/index.module.scss

li {

// not use for now

Copy link

Member

ovflowd Jul 4, 2023

Choose a reason for hiding this comment

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

Please remove this commented code 😅

ovflowd reviewed Jul 4, 2023

View reviewed changes

ovflowd closed this Jul 27, 2023

avivkeller removed this from Node.js Website May 3, 2025

Uh oh!

Feat(toc): Introduce #5399

Feat(toc): Introduce #5399

Uh oh!

Conversation

AugustinMauroy commented May 24, 2023

Description

Related Issues

Check List

Uh oh!

vercel bot commented May 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vercel bot commented May 24, 2023

Uh oh!

AugustinMauroy commented May 24, 2023

Uh oh!

AugustinMauroy commented May 25, 2023

Uh oh!

ovflowd left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ovflowd commented Jul 2, 2023

Uh oh!

AugustinMauroy commented Jul 4, 2023

Uh oh!

ovflowd Jul 4, 2023

Choose a reason for hiding this comment

Uh oh!

ovflowd Jul 4, 2023

Choose a reason for hiding this comment

Uh oh!

ovflowd commented Jul 4, 2023

Uh oh!

ovflowd Jul 4, 2023

Choose a reason for hiding this comment

Uh oh!

ovflowd Jul 4, 2023

Choose a reason for hiding this comment

Uh oh!

ovflowd Jul 4, 2023

Choose a reason for hiding this comment

Uh oh!

bmuenzenmeyer commented Jul 15, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

vercel bot commented May 24, 2023 •

edited

Loading