Markdown の画面

画面の content: は、lib/resources/ の Markdown のリソースを指定します。一つのファイル、または {*name} で終わるパスではフォルダーで、その場合はアドレスの残りに .md を付けたものがファイルです。RouteContentView は、MarkdownView を通じてそれをテーマで表示します。フォルダーの別の Markdown ファイルへのリンクはその画面を開くため、Markdown のフォルダーがそのままサイトになります。

使う理由

ドキュメント、ヘルプ、法的なページは、ウィジェットではなくファイルです。{*path} のルートを持つ一つの画面がフォルダー全体を表示し、各ファイルは独自のアドレスを持ち、その間のリンクは Web ページと同じように動きます。同じファイルは、spring.flutter.web.seo.from-routes で検索エンジンのための HTML ページになります。今読んでいるサイトもこの方法で作られています。

例

@ScreenRoute('/docs/{*path}', title: 'Docs', content: 'resources:content/docs/')
class DocPage extends StatelessWidget {
  const DocPage({super.key});

  @override
  Widget build(BuildContext context) =>
      const SingleChildScrollView(child: RouteContentView());
}
アドレス ファイル
/docs lib/resources/content/docs/index.md
/docs/core/beans lib/resources/content/docs/core/beans.md
/docs/guides lib/resources/content/docs/guides/index.md (フォルダー自身のページ)
/ja/docs/core/beans lib/resources/content/docs/core/beans.ja.md、翻訳がなければ beans.md (languages: [en, ja] の場合)

ファイルの中の相対リンクは、index.md も含め、そのファイル自身のフォルダーからの相対で、どのルート (resources: または asset:) のフォルダーでも同じです。サイトの Markdown ファイルへのリンクはその画面を開き、それ以外のリンクは onLink に渡されます。

RouteContentView

パラメーター デフォルト 意味
onLink なし サイトのどの Markdown ファイルでもないリンク (https のアドレス) で呼ばれる
selectable true テキストを選択できるかどうか
outline なし ページの見出しを受け取る MarkdownOutline。「このページの内容」のリストに使う
scrollToTop true ブラウザーがページを開くように、ルートの別のページは、それがあるスクロール領域の先頭から始まる。位置はテーマの方法で戻る (motion.scroll-to-top、デフォルトは 400ms の ease-out-cubic、none でジャンプ)。#anchor は代わりにその見出しまでスクロールし、同じページの翻訳は位置を保つ

メニューのためのページ一覧

サイトは、フォルダーの contents.md ファイルからメニューを読みます。spring.flutter.web.seo.exclude: ['**/contents*.md'] で、それらを検索エンジンのためのページから除外してください。

関連項目