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(site) internal page anchors and referencing mechanism automation #1820

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

HenadzV
Copy link
Contributor

@HenadzV HenadzV commented Jul 21, 2023

In the scope of this PR was added automatic functionality for adding headers IDs and creating inpage anchors/referencing links.

Closes: #1456
Closes: #1457

@HenadzV HenadzV added the documentation Improvements or additions to documentation label Jul 21, 2023
@HenadzV HenadzV requested review from a team, dshovchko, ala-n and yadamskaya and removed request for a team July 21, 2023 09:15
<body>
This commit adds the `generateHeadersIds` and `generateAnchors` functions to the MDRenderer class. These functions are responsible for generating header IDs and anchor links in the rendered markdown content.
<body>
This commit adds the `generateGloballyDefinedTermsLinks` function to the MDRenderer class. This function generates  links for globally defined terms
@HenadzV HenadzV force-pushed the docs/internal-page-anchors branch from b504ec1 to c8bb7d9 Compare July 25, 2023 14:24
@codeclimate
Copy link

codeclimate bot commented Jul 25, 2023

Code Climate has analyzed commit c8bb7d9 and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 100.0% (50% is the threshold).

This pull request will bring the total coverage in the repository to 49.2% (0.0% change).

View more on Code Climate.

pages/11ty/markdown.shortcut.js Outdated Show resolved Hide resolved
pages/11ty/markdown.shortcut.js Outdated Show resolved Hide resolved
pages/11ty/markdown.shortcut.js Outdated Show resolved Hide resolved
pages/11ty/markdown.shortcut.js Outdated Show resolved Hide resolved
@ala-n ala-n changed the base branch from main to epic/redesign July 25, 2023 15:13
@ala-n ala-n requested a review from abarmina July 25, 2023 15:13
@ala-n ala-n added the site Feature, enhancement or bug for demo site label Jul 25, 2023
Copy link
Collaborator

@ala-n ala-n left a comment

Choose a reason for hiding this comment

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

Please make sure the approach is optimized and aligned with the project architecture. (according to notes above)

TODO: discuss Mn sync-up
CC: @HenadzV , @abarmina

…arks

<body>
This commit separates functionality for different methods, adjusts Regex
pages/11ty/markdown.shortcut.js Outdated Show resolved Hide resolved
pages/11ty/markdown.shortcut.js Outdated Show resolved Hide resolved
pages/11ty/markdown.shortcut.js Outdated Show resolved Hide resolved
pages/11ty/markdown.shortcut.js Outdated Show resolved Hide resolved
pages/11ty/markdown.shortcut.js Outdated Show resolved Hide resolved
@ala-n ala-n changed the base branch from epic/redesign to main August 4, 2023 03:11
@ala-n ala-n changed the base branch from main to epic/redesign August 4, 2023 03:12
<body>
This commit put in order code according project code style guide
@ala-n ala-n added the needs review The PR is waiting for review label Aug 4, 2023
@ala-n ala-n modified the milestones: 🍀 GH Pages Redesign Enhancements, 🍀 GH Pages Redesign - September 2023, 🍀 GH Pages Redesign - August 2023 Aug 8, 2023
@HenadzV HenadzV requested a review from ala-n August 28, 2023 08:49
pages/11ty/markdown.shortcut.js Show resolved Hide resolved
pages/11ty/markdown.shortcut.js Outdated Show resolved Hide resolved
pages/11ty/markdown.shortcut.js Outdated Show resolved Hide resolved
pages/11ty/markdown.shortcut.js Outdated Show resolved Hide resolved
<body>
changes according PR review
@ala-n ala-n modified the milestones: 🍀 GH Pages Redesign - August 2023, 🍀 GH Pages Redesign - September 2023 Sep 4, 2023
pages/11ty/markdown.shortcut.js Outdated Show resolved Hide resolved
pages/11ty/markdown.shortcut.js Outdated Show resolved Hide resolved
pages/11ty/markdown.shortcut.js Outdated Show resolved Hide resolved
pages/11ty/markdown.shortcut.js Outdated Show resolved Hide resolved
pages/11ty/markdown.shortcut.js Outdated Show resolved Hide resolved
<body>
add missed semicolons
@ala-n ala-n added finalization Changes is under final review and live testing and removed needs review The PR is waiting for review labels Sep 28, 2023
@ala-n
Copy link
Collaborator

ala-n commented Sep 28, 2023

@ala-n and @abarmina to check if the actual cases are covered and update related content

@ala-n ala-n changed the title docs(eslDoc) internal page anchors and referencing mechanism automation docs(site) internal page anchors and referencing mechanism automation Sep 28, 2023
Base automatically changed from epic/redesign to main December 27, 2023 22:41
@ala-n ala-n removed the finalization Changes is under final review and live testing label Jan 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation site Feature, enhancement or bug for demo site
Projects
None yet
4 participants