オンラインエディター
オンラインエディターの説明。
このページでは、当社のオンラインエディターの使い方を説明します。
オンラインエディターは、すべてのissueとプルリクエストに使用する必要があります!
ログイン方法
ログインは非常に簡単で、右上のSign in with GitHubボタンを押してGitHub経由でログインするだけです。
基本機能とページ構造
当社のオンラインエディターは、bootstrap-table用の簡単なサンプル/デモを作成するために設計されました。
ページは次のように構成されています。
トップナビバー
5つのボタンがあります。
- 実行:実行ボタンは、現在のバージョンの例を表示します。
- 保存:保存ボタンは、例を保存します。保存を押した後、URLは
https://live.bootstrap-table.com/code/<username>/<ID>
のように変更されます。 - ライブラリ:このボタンは設定ページを開きます。このページでは、例の環境を設定できます。
- Bootstrap Tableソース:このオプションは、どのバージョンのソース(CDNまたはGitHubからのソースとして)を使用するかを定義します。
GitHub srcから
を選択した場合、例に使用されるブランチを設定できます。Issueの場合、通常は常にリリース済みCDNから
を使用します。 - リリースCDNバージョン:ここでは、古いbootstrap-tableバージョンの例を作成するために、bootstrap-tableのバージョンを選択できます。
- テーマ:ここでは、特定のテーマでのIssueを示すためなど、サポートされているテーマから選択できます。
- 拡張機能:拡張機能の使用を説明する場合は、ここで簡単に選択できます。つまり、例に自分で含める必要はありません!
- Bootstrap Tableソース:このオプションは、どのバージョンのソース(CDNまたはGitHubからのソースとして)を使用するかを定義します。
- 例をロード:このオプションはページを開き、既存の例をロードできます(これは当社の例のページの「ミラー」です)。
- リンク:最後のボタンには、当社のウェブサイト、GitHubページなどへのリンクがいくつかあります。
左側
HTML、CSS、JavaScriptを含む例を作成できます(cssとjavascriptには、<style></style>
および/または<script></script>
タグが必要です!)。
基本的なテンプレートは
<!-- Includes custom css and js files -->
<link rel="stylesheet" href="https://example.com/custom.css">
<script src="https://example.com/custom.js"></script>
<!-- Define custom style -->
<style>
</style>
<!-- No need to write <html> and <body> tags -->
<table id="table">
</table>
<script>
$(function () {
$('#table').bootstrapTable()
})
</script>
注:jQueryとbootstrap-tableがロードされていることを確認するために、初期化関数を$(function () {})
に入れる必要があります。
右側
実行中の例(実行ボタンを押した後)を確認できます。
結果(フルスクリーン)をクリックして、実行中の例のフルスクリーンを切り替えることもできます。
Issueのワークフロー
各Issueには、問題の例(オンラインエディターで作成)が含まれている必要があります。
- オンラインエディターを開きます。
- ライブラリページに移動し、例の環境を設定します。
- バージョン
- テーマ
- 拡張機能
- 例を書き出す(またはローカルプロジェクトからコピーする)。
- 例で問題が再現できるかどうかを確認します。
- 例を保存し(保存ボタンを押して)、URLをコピーします。
- 例のURLを含むIssueを開きます。
(場合によっては、2と3の代わりに、既存の例をロードするために[例をロード]ボタンを使用することもできます)。
プルリクエストのワークフロー
PRのワークフローは、Issueのワークフローと非常に似ています。
唯一の違いは、ブランチを選択する必要があることです(エディターはあなたのコードを使用して例を作成します)。そのためには、ライブラリページ
を開き、Bootstrap Tableソース
オプションでGitHub srcから
を選択し、GitHub srcブランチ
入力にブランチ名を書き込みます。ブランチ名の構文は<username>:<branch>
です。プルリクエストページからその文字列をコピーすることもできます。