-
Notifications
You must be signed in to change notification settings - Fork 3.5k
Move location of secondary output Markdown pages #13593
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
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
6dd192e
Move location of secondary output Markdown pages
parlough 160e3a3
Merge branch 'main' into feat/markdown-output
parlough 14274ee
Address Gemini review suggestion
parlough 49ce023
Apply additional hardenings suggested by Gemini review
parlough 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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| // Copyright 2026 The Flutter Authors. All rights reserved. | ||
| // Use of this source code is governed by a BSD-style license that can be | ||
| // found in the LICENSE file. | ||
|
|
||
| import 'package:jaspr_content/jaspr_content.dart'; | ||
|
|
||
| /// The Markdown secondary output shared by routing and page layouts. | ||
| final canonicalMarkdownOutput = CanonicalMarkdownOutput( | ||
| createHeader: _createHeader, | ||
| ); | ||
|
|
||
| /// Outputs a secondary Markdown file at the canonical page URL with a `.md` | ||
| /// suffix. | ||
| final class CanonicalMarkdownOutput extends MarkdownOutput { | ||
| CanonicalMarkdownOutput({super.createHeader}); | ||
|
|
||
| /// Returns the secondary Markdown route for [page], if one is generated. | ||
| String? routeForPage(Page page) { | ||
| if (pattern.matchAsPrefix(page.path) == null) return null; | ||
| return createRoute(page.url); | ||
| } | ||
|
|
||
| @override | ||
| String createRoute(String route) { | ||
| // Keep Markdown URLs absolute and avoid a `/.md` suffix. | ||
| final absoluteRoute = route.startsWith('/') ? route : '/$route'; | ||
| final normalizedRoute = absoluteRoute.endsWith('/') | ||
| ? absoluteRoute.substring(0, absoluteRoute.length - 1) | ||
| : absoluteRoute; | ||
| return normalizedRoute.isEmpty ? '/index.md' : '$normalizedRoute.md'; | ||
| } | ||
|
parlough marked this conversation as resolved.
|
||
| } | ||
|
|
||
| String _createHeader(Page page) { | ||
| final header = StringBuffer(); | ||
| if (page.data.page['title'] case final String title when title.isNotEmpty) { | ||
| header.writeln('# $title'); | ||
|
|
||
| if (page.data.page['description'] case final String description | ||
| when description.isNotEmpty) { | ||
| header.writeln(); | ||
| header.writeln('> $description'); | ||
| } | ||
| } | ||
|
|
||
| return header.toString(); | ||
| } | ||
2 changes: 1 addition & 1 deletion
2
sites/docs/src/content/tools/devtools/release-notes/release-notes-2.21.1.md
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
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.
Uh oh!
There was an error while loading. Please reload this page.