Skip to content

Include page title and description in md output #12639

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.

Sign up for GitHub

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 2 commits into from
Nov 5, 2025
Merged

Include page title and description in md output #12639

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0434040
Include page title and description in md output
parlough Nov 5, 2025
e8c999e
Merge branch 'main' into feat/header-in-markdown-output
parlough Nov 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion site/lib/main.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,26 @@ Component get _docsFlutterDevSite => ContentApp.custom(
components: _embeddableComponents,
layouts: const [DocLayout(), TocLayout(), CatalogPageLayout()],
theme: const ContentTheme.none(),
secondaryOutputs: [const RobotsTxtOutput(), MarkdownOutput()],
secondaryOutputs: [
const RobotsTxtOutput(),
MarkdownOutput(
createHeader: (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();
},
),
],
),
);

Expand Down
4 changes: 2 additions & 2 deletions site/lib/src/components/common/tabs.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ import 'package:jaspr_content/jaspr_content.dart';
import '../../util.dart';

/// A tabs component where children tabs can be switched between by the user.
class DashTabs implements CustomComponent {
class DashTabs extends CustomComponent {
static int _currentTabWrapperId = 0;
static int _currentTabId = 0;

const DashTabs();
const DashTabs() : super.base();

@override
Component? create(Node node, NodesBuilder builder) {
Expand Down
8 changes: 4 additions & 4 deletions site/pubspec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ environment:
dependencies:
build: ^4.0.2
collection: ^1.19.1
crypto: ^3.0.6
crypto: ^3.0.7
html: ^0.15.6
http: ^1.5.0
jaspr: ^0.21.6
jaspr_content: ^0.4.2
jaspr_content: ^0.4.3
# Used as our template engine.
liquify: ^1.3.1
markdown: ^7.3.0
Expand All @@ -32,9 +32,9 @@ dev_dependencies:
path: pkgs/analysis_defaults
ref: f91ed8ecef6a0b31685804fe4102b25fda021460
build_runner: ^2.10.1
build_web_compilers: ^4.3.0
build_web_compilers: ^4.4.0
jaspr_builder: ^0.21.6
sass: ^1.93.2
sass: ^1.93.3
sass_builder: ^2.4.0

jaspr:
Expand Down
Loading