-
Notifications
You must be signed in to change notification settings - Fork 26.4k
docs: update what is angular page #62276
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
Open
devchas
wants to merge
1
commit into
angular:main
Choose a base branch
from
devchas:overview
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+3,029
−210
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
155 changes: 155 additions & 0 deletions
155
adev/shared-docs/pipeline/guides/extensions/docs-card/docs-nav-card.mts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,155 @@ | ||
| /*! | ||
| * @license | ||
| * Copyright Google LLC All Rights Reserved. | ||
| * | ||
| * Use of this source code is governed by an MIT-style license that can be | ||
| * found in the LICENSE file at https://angular.dev/license | ||
| */ | ||
|
|
||
| import {Tokens, Token, RendererThis, TokenizerThis} from 'marked'; | ||
| import {loadWorkspaceRelativeFile} from '../../utils.mjs'; | ||
|
|
||
| interface DocsNavCardToken extends Tokens.Generic { | ||
| type: 'docs-nav-card'; | ||
| title: string; | ||
| items: string; | ||
| tokens: Token[]; | ||
| iconImgSrc?: string; // Need image since icons are custom | ||
| } | ||
|
|
||
| // Capture group 1: all attributes on the opening tag | ||
| // Capture group 2: all content between the open and close tags | ||
| const navCardRule = /^[^<]*<docs-nav-card\s([^>]*)>((?:.(?!\/docs-nav-card))*)<\/docs-nav-card>/s; | ||
| const titleRule = /title="([^"]*)"/; | ||
| const hrefRule = /href="([^"]*)"/; | ||
| const iconImgSrcRule = /iconImgSrc="([^"]*)"/; | ||
|
|
||
| export const docsNavCardExtension = { | ||
| name: 'docs-nav-card', | ||
| level: 'block' as const, | ||
| start(src: string) { | ||
| return src.match(/^\s*<docs-nav-card\s*/m)?.index; | ||
| }, | ||
| tokenizer(this: TokenizerThis, src: string): DocsNavCardToken | undefined { | ||
| const match = navCardRule.exec(src); | ||
|
|
||
| if (match) { | ||
| const attr = match[1].trim(); | ||
| const title = titleRule.exec(attr); | ||
| const iconImgSrc = iconImgSrcRule.exec(attr); | ||
|
|
||
| const items = match[2].trim(); | ||
|
|
||
| const token: DocsNavCardToken = { | ||
| type: 'docs-nav-card', | ||
| raw: match[0], | ||
| title: title ? title[1] : '', | ||
| items: items ?? '', | ||
| iconImgSrc: iconImgSrc ? iconImgSrc[1] : undefined, | ||
| tokens: [], | ||
| }; | ||
| this.lexer.blockTokens(token.items, token.tokens); | ||
| return token; | ||
| } | ||
| return undefined; | ||
| }, | ||
| renderer(this: RendererThis, token: DocsNavCardToken) { | ||
| // We need to read svg content, instead of renering svg with `img`, | ||
| // cause we would like to use CSS variables to support dark and light mode. | ||
| const illustration = loadWorkspaceRelativeFile( | ||
| 'adev/src/assets/images/editor-light-horizontal.svg', | ||
| ); | ||
|
|
||
| // We can assume that all icons are svg files since they are custom. | ||
| // We need to read svg content, instead of renering svg with `img`, | ||
| // cause we would like to use CSS variables to support dark and light mode. | ||
| let icon = ''; | ||
| if (token.iconImgSrc) { | ||
| icon = loadWorkspaceRelativeFile(token.iconImgSrc); | ||
| } | ||
|
|
||
| return ` | ||
| <div class="docs-nav-card"> | ||
| <div class="docs-nav-card-title"> | ||
| ${icon} | ||
| <h6>${token.title}</h6> | ||
| </div> | ||
| <div class="docs-nav-card-content"> | ||
| <div class="docs-nav-card-links"> | ||
| ${this.parser.parse(token.tokens)} | ||
| </div> | ||
| <div class="docs-nav-card-svg"> | ||
| ${illustration} | ||
| </div> | ||
| </div> | ||
| </div> | ||
| `; | ||
| }, | ||
| }; | ||
|
|
||
| interface DocsNavLinkToken extends Tokens.Generic { | ||
| type: 'docs-nav-link'; | ||
| title: string; | ||
| body: string; | ||
| href: string; | ||
| iconImgSrc?: string; // Need image since icons are custom | ||
| bodyTokens: Token[]; | ||
| } | ||
|
|
||
| // Capture group 1: all attributes on the opening tag | ||
| // Capture group 2: all content between the open and close tags | ||
| const navLinkRule = /^[^<]*<docs-nav-link\s([^>]*)>((?:.(?!\/docs-nav-link))*)<\/docs-nav-link>/s; | ||
|
|
||
| export const docsNavLinkExtension = { | ||
| name: 'docs-nav-link', | ||
| level: 'block' as const, | ||
| start(src: string) { | ||
| src.match(/^\s*<docs-nav-link/m)?.index; | ||
| }, | ||
| tokenizer(this: TokenizerThis, src: string): DocsNavLinkToken | undefined { | ||
| const match = navLinkRule.exec(src); | ||
|
|
||
| if (match) { | ||
| const attr = match[1].trim(); | ||
| const title = titleRule.exec(attr); | ||
| const iconImgSrc = iconImgSrcRule.exec(attr); | ||
| const href = hrefRule.exec(attr); | ||
|
|
||
| const body = match[2].trim(); | ||
|
|
||
| const token: DocsNavLinkToken = { | ||
| type: 'docs-nav-link', | ||
| raw: match[0], | ||
| title: title ? title[1] : '', | ||
| href: href ? href[1] : '', | ||
| body: body ?? '', | ||
| iconImgSrc: iconImgSrc ? iconImgSrc[1] : undefined, | ||
| bodyTokens: [], | ||
| }; | ||
| this.lexer.blockTokens(token.body, token.bodyTokens); | ||
| return token; | ||
| } | ||
| return undefined; | ||
| }, | ||
| renderer(this: RendererThis, token: DocsNavLinkToken) { | ||
| // We can assume that all icons are svg files since they are custom. | ||
| // We need to read svg content, instead of renering svg with `img`, | ||
| // cause we would like to use CSS variables to support dark and light mode. | ||
| let icon = ''; | ||
| if (token.iconImgSrc) { | ||
| icon = loadWorkspaceRelativeFile(token.iconImgSrc); | ||
| } | ||
|
|
||
| return ` | ||
| <a href="${token.href}" class="docs-card docs-nav-link"> | ||
| <div class="docs-card-text-content"> | ||
| <div class="docs-nav-link-title"> | ||
| ${icon} | ||
| <h3>${token.title}</h3> | ||
| </div> | ||
| ${this.parser.parse(token.bodyTokens)} | ||
| </div> | ||
| </a> | ||
| `; | ||
| }, | ||
| }; |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: these two would be cleaner as
constternaries