Laravelインデックス

ReadDouble

PHP Frameworks

Laravel

Document(ドキュメント)

Laravelは半年ごとに新バージョンがリリースされます。次回のリリースまでバグフィックス対応、機能追加され、その後の6ヶ月間セキュリティ脆弱性の対応期間です。LTSバージョンは2年毎にリリースされ、セキュリティ脆弱性の対応はリリース後3年間です。

Read × 2 = So readable!!

2倍(Double)の読みやすさを!

To Read Documents, For Documents readers.

ドキュメントを読む人のために。ドキュメントを読むためのサイト。

何でできてるの?

プレーンなhtmlサイトで、CSSフレームワークにはFoundation6を使用しています。Markdown形式の内容をHTMLに変換するためにPandocを利用しています。コードのハイライトにはhighlight.jsを使用しています。その他には特別なツールは使用しておらず、awkやsedなど、一般的なコマンドラインツールとbashスクリプトで、HTMLファイルを生成しています。

特徴は?

文中のヘッダー構造(H2〜H4)を表示できます。これにより文章の構造が捉えやすくなります。移動も可能です。キーボードによるヘッダー間の移動をサポートしています。?キーでヘルプが表示されます。

左オフキャンバスでは、同じバージョンの別のページ(章)へ切り替えられます。右オフキャンバスは、日英の切り替えとバージョンの切り替えです。バージョンは同じファイル名のバージョン違いへ移動します。同じ名前のファイルが存在しない場合は、404ページが表示されます。

また、カラーテーマ、ラージスクリーンの表示幅、インデント、フォントの切り替えも右キャンバスにあります。ここらへんは好みがあり、万人向けのデザインはありません。お好みに合わせ、設定してください。

さらに、一部の和文を選択可能にしました。ある英文に対してどの日本語を採用するかも、好みが大きく答えがありません。

サポートブラウザ

開発者のためのドキュメントサイトです。最新のFirefoxとChormeのみサポートしています。

利用者が圧倒的に多い、デスクトップ向けサイトです。モバイル向けには調整していません。

知られている不具合

ヘッダーの移動機能は、多少位置がずれることがあります。おおよその場所へ移動する機能と考えてください。

機能を盛り込んだため、最初のバージョンより表示に時間がかかります。

和訳に誤訳やタイポが紛れ込むことがあります。

Laravel専用?

ライセンスに問題がないドキュメントで、需要があるものなら載せます。ライセンスに問題がないもの専用です。

この条件で探すと、なかなか良い物件が見つかりません。

ドキュメント章別ページ

ドキュメントの存在するURL階層ではありません。

ヘッダー項目移動

注目:アイコン:ページ内リンク設置(リンクがないヘッダーへの移動では、リンクがある以前のヘッダーのハッシュをURLへ付加します。

移動

クリックで即時移動します。

バージョン

設定

適用ボタンクリック後に、全項目まとめて適用されます。

カラーテーマ
和文指定 Pagination
和文指定 Scaffold
Largeスクリーン表示幅
インデント
本文フォント
コードフォント
フォント適用確認

フォントの指定フィールドから、フォーカスが外れると、当ブロックの内容に反映されます。EnglishのDisplayもPreviewしてください。

フォント設定時、表示に不具合が出た場合、当サイトのクッキーを削除してください。

バックスラッシュを含むインライン\Code\Blockの例です。

以下はコードブロックの例です。

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * ユーザに関連する電話レコードを取得
     */
    public function phone()
    {
        return $this->hasOne('App\Phone');
    }
}

設定を保存する前に、表示が乱れないか必ず確認してください。CSSによるフォントファミリー指定の知識がない場合は、フォントを変更しないほうが良いでしょう。

キーボード・ショートカット

オープン操作

PDC

ページ(章)移動の左オフキャンバスオープン

HA

ヘッダー移動モーダルオープン

MS

移動/設定の右オフキャンバスオープン

ヘッダー移動

T

最初のヘッダーへ移動

E

最後のヘッダーへ移動

NJ

次ヘッダー(H2〜H4)へ移動

BK

前ヘッダー(H2〜H4)へ移動

その他

?

このヘルプページ表示
閉じる