# lsx 機能を使ってページリストを表示する

lsx 機能を使うと、特定のページの配下に存在するページを一覧表示できます。

たとえばあるページに $lsx() と記述すると、画像のようにそのページの配下に存在するページ一覧を出力できます。

複数のページへのショートカットを記載したいときなどに便利です。

# 指定したページの配下ページ一覧を出力する

ページの指定方法は、ルートページからの絶対パスと、編集中のページからの相対パスの 2 種類です。

存在しないページを指定した場合、$lsx(/サンプル) has no contents のようなエラーメッセージが表示されます。

lsx 機能には、複数のオプション設定があります。同時に複数のオプションを設定する場合は、カンマ区切りで $lsx(/ページ, depth=1, sort=createdAt, reverse=true) のように記述します。

パラメータ	デフォルト値	説明	詳細
num	50	ページ数を指定する	numオプション詳細
depth	未設定	ページの階層を指定する	depthオプション詳細
sort	path	ページの並び順を指定する	sortオプション詳細
reverse	false	ページの並び順を逆にする	reverseオプション詳細
filter	未設定	ページをフィルタする	filterオプション詳細
except	未設定	ページを除外する	exceptオプション詳細

出力するページの数を指定できます。デフォルトの値は 50 です。

$lsx(num=N) : N 件のページを出力します。N には自然数を入力してください。
: や + を使って、出力するページを制御できます。
- $lsx(num=1:10) : 1件目から10件目までのページを出力します。
- $lsx(num=2:) : 2件目から最後までのページを出力します。
- $lsx(num=5+2) : 5件目から2件先まで (5,6,7番目)のページを出力します。

出力するページの階層を指定できます。デフォルトでは、存在する全ての階層のページを出力します。

$lsx(depth=N) : 編集中のページ、もしくは指定したページを起点にして、N 階層下のページまで出力します。N には自然数を入力してください。
: や + を使って、出力するページを制御できます。
- $lsx(depth=2:3) : 2階層下から3階層下までのページを出力します。
- $lsx(depth=2:) : 2階層下から最下層までのページを出力します。
- $lsx(depth=1+2) : 1階層下から2階層先まで (1,2,3階層下)のページを出力します。

ページ一覧の並び順を、以下のいずれかで指定できます。

出力順を逆にします。

出力するページを、ページ名に含まれる文字列でフィルタできます。filter のマッチタイプは部分一致です。

出力するページを、ページ名に含まれる文字列で除外できます。except のマッチタイプは部分一致です。