markdown-design-doc-viewer 1.4.0 → 1.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.ja.md +1 -1
- package/README.md +1 -1
- package/ThirdPartyNotices.txt +20 -35
- package/dist/cli.js +55 -54
- package/dist/export.css +1 -1
- package/dist/export.js +2 -2
- package/dist/webview.css +1 -1
- package/dist/webview.js +539 -537
- package/l10n/bundle.l10n.ja.json +34 -1
- package/package.json +1 -1
package/README.ja.md
CHANGED
|
@@ -52,7 +52,7 @@ md-design-doc export docs -o site
|
|
|
52
52
|
| `--no-table-tree-highlight` | ツリーとして表示する表(表のオプションの `level=`)で、マウスを乗せた行の親と子をハイライトしない |
|
|
53
53
|
| `--no-toc` | ページの右端にマウスを乗せると開く目次(見出し h1〜h3)を表示しない |
|
|
54
54
|
| `--chrome <path>` | 図の描画に使う Chrome か Chromium |
|
|
55
|
-
| `--strict` | 警告(壊れた `@ref
|
|
55
|
+
| `--strict` | 警告(壊れた `@ref`、置き場所の誤ったマーカー、2 回定義したノートのラベルや遷移先の見つからないラベルなどの紐付けの警告、適用できない表のオプション、何にも一致しないワイヤーフレームのパーツのセレクタ(`item.<番号>=`))があれば失敗にする。紐付いていないだけの矢印・見出しでは失敗しない |
|
|
56
56
|
| `--diff-base <rev>` | 各文書の、git のリビジョン `<rev>`(タグ・コミット・ブランチ)からの差分を表示する。VS Code 拡張の履歴との比較と同じく、追加・変更・削除したブロックに緑・青・赤の帯を付け、変わった語を強調し、変更した図には変更前の図を折りたたんで添える。ページ下部のバーで前後の変更へ移動したり、差分を隠したり表示したりできる。そのリビジョンの同じパスにない文書(その後に追加・名前を変更したもの)は全体を追加として表示する。git と、クローンにそのリビジョンまでの履歴が必要([GitHub Actions](#github-actions) を参照)。`--index` と使うと、一覧に各文書の差分の列が付く |
|
|
57
57
|
| `--index` | 書き出した文書の一覧を `--out-dir`(必須)の `index.html` にも書き出す。フォルダごとの表に、タイトル(リンク)・ファイル名と、front matter の `version`・`product`・`status`・`updated` を載せる。ページの検索欄で文書を絞り込め、列見出しで並べ替えられる |
|
|
58
58
|
| `--index-title <title>` | `index.html` のタイトル。既定は `Design Docs`(`--lang ja` では `設計書一覧`) |
|
package/README.md
CHANGED
|
@@ -52,7 +52,7 @@ md-design-doc export docs -o site
|
|
|
52
52
|
| `--no-table-tree-highlight` | Do not highlight the parents and children of the row under the pointer in the tables shown as trees (`level=` of the table options). |
|
|
53
53
|
| `--no-toc` | Do not show the table of contents (headings h1-h3) that opens when hovering the right edge of the page. |
|
|
54
54
|
| `--chrome <path>` | Chrome or Chromium to render the diagrams with. |
|
|
55
|
-
| `--strict` | Fail when a document has a warning: a link warning (a broken `@ref
|
|
55
|
+
| `--strict` | Fail when a document has a warning: a link warning (a broken `@ref`, a misplaced marker, or a label of a note defined twice or not found by a jump), table options that cannot be applied, or a selector of the parts of a wireframe (`item.<number>=`) that matches nothing. Arrows and headings that are only not linked do not fail. |
|
|
56
56
|
| `--diff-base <rev>` | Show the changes of each document since the git revision `<rev>` (a tag, a commit or a branch), as the VS Code extension shows its differences from a revision: the blocks added, changed and deleted are marked with green, blue and red bands, the words changed are highlighted, and the old version of a changed diagram is shown folded below it. A bar at the bottom of the page goes from one change to the next, and hides or shows them. A document the revision does not have at its path (added or renamed since) is shown as all added. Requires git, and the history of the revision in the clone (see [GitHub Actions](#github-actions)). With `--index`, the list has a column of the changes of each document. |
|
|
57
57
|
| `--index` | Also write `index.html` in `--out-dir` (required), a list of the exported documents: a table for each folder, with their title (linked), file name, and the `version`, `product`, `status` and `updated` of their front matter. The page has a search box that filters the documents, and its column headers sort them. |
|
|
58
58
|
| `--index-title <title>` | Title of `index.html`. Default: `Design Docs` (`設計書一覧` with `--lang ja`). |
|
package/ThirdPartyNotices.txt
CHANGED
|
@@ -1,14 +1,15 @@
|
|
|
1
1
|
Markdown Design Doc Viewer includes the following third-party material.
|
|
2
2
|
|
|
3
|
-
The npm packages are bundled into the scripts of the extension, the command line
|
|
4
|
-
with what it is bundled in, its license and its repository, where its source
|
|
3
|
+
The npm packages are bundled into the scripts of the extension, the command line, the desktop app and the embeddable
|
|
4
|
+
viewer (its npm package); each is listed with what it is bundled in, its license and its repository, where its source
|
|
5
|
+
code is available (also on npm).
|
|
5
6
|
This file is generated by scripts/third-party-notices.mjs (pnpm notices).
|
|
6
7
|
The licenses of the Rust crates of the desktop app are in ThirdPartyLicenses.txt, next to this file in the desktop app
|
|
7
8
|
(desktop/src-tauri/ThirdPartyLicenses.txt in the repository).
|
|
8
9
|
|
|
9
10
|
================================================================================
|
|
10
11
|
GitHub Octicons (https://github.com/primer/octicons)
|
|
11
|
-
Used for the icons of GitHub alerts (src/markdownExtras.ts).
|
|
12
|
+
Used for the icons of GitHub alerts (src/markdown/markdownExtras.ts).
|
|
12
13
|
================================================================================
|
|
13
14
|
|
|
14
15
|
MIT License
|
|
@@ -1179,7 +1180,7 @@ SOFTWARE.
|
|
|
1179
1180
|
|
|
1180
1181
|
================================================================================
|
|
1181
1182
|
diff 8.0.4 (BSD-3-Clause): https://github.com/kpdecker/jsdiff
|
|
1182
|
-
in the extension, the command line and the
|
|
1183
|
+
in the extension, the command line, the desktop app and the embeddable viewer
|
|
1183
1184
|
================================================================================
|
|
1184
1185
|
|
|
1185
1186
|
BSD 3-Clause License
|
|
@@ -1213,8 +1214,8 @@ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
|
1213
1214
|
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
1214
1215
|
|
|
1215
1216
|
================================================================================
|
|
1216
|
-
dompurify 3.4.
|
|
1217
|
-
in the extension, the command line and the
|
|
1217
|
+
dompurify 3.4.17 (MPL-2.0 OR Apache-2.0): https://github.com/cure53/DOMPurify
|
|
1218
|
+
in the extension, the command line, the desktop app and the embeddable viewer
|
|
1218
1219
|
================================================================================
|
|
1219
1220
|
|
|
1220
1221
|
--- LICENSE ---
|
|
@@ -1798,7 +1799,7 @@ Exhibit B - "Incompatible With Secondary Licenses" Notice
|
|
|
1798
1799
|
defined by the Mozilla Public License, v. 2.0.
|
|
1799
1800
|
|
|
1800
1801
|
================================================================================
|
|
1801
|
-
elkjs 0.
|
|
1802
|
+
elkjs 0.12.1 (EPL-2.0 OR GPL-3.0-or-later): https://github.com/kieler/elkjs
|
|
1802
1803
|
in the extension, the command line and the desktop app
|
|
1803
1804
|
================================================================================
|
|
1804
1805
|
|
|
@@ -2054,8 +2055,7 @@ No third-party beneficiary rights are created under this Agreement.
|
|
|
2054
2055
|
|
|
2055
2056
|
“This Source Code may also be made available under the following
|
|
2056
2057
|
Secondary Licenses when the conditions for such availability set forth
|
|
2057
|
-
in the Eclipse Public License, v. 2.0 are satisfied:
|
|
2058
|
-
version(s), and exceptions or additional permissions here}.”
|
|
2058
|
+
in the Eclipse Public License, v. 2.0 are satisfied: GNU General Public License v3.0 or later”
|
|
2059
2059
|
|
|
2060
2060
|
> Simply including a copy of this Agreement, including this Exhibit A is
|
|
2061
2061
|
> not sufficient to license the Source Code under Secondary Licenses.
|
|
@@ -2069,7 +2069,7 @@ version(s), and exceptions or additional permissions here}.”
|
|
|
2069
2069
|
|
|
2070
2070
|
================================================================================
|
|
2071
2071
|
entities 8.1.0 (BSD-2-Clause): https://github.com/fb55/entities
|
|
2072
|
-
in the extension, the command line and the
|
|
2072
|
+
in the extension, the command line, the desktop app and the embeddable viewer
|
|
2073
2073
|
================================================================================
|
|
2074
2074
|
|
|
2075
2075
|
Copyright (c) Felix Böhm
|
|
@@ -2157,7 +2157,7 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
|
2157
2157
|
|
|
2158
2158
|
================================================================================
|
|
2159
2159
|
highlight.js 11.12.0 (BSD-3-Clause): https://github.com/highlightjs/highlight.js
|
|
2160
|
-
in the extension, the command line and the
|
|
2160
|
+
in the extension, the command line, the desktop app and the embeddable viewer
|
|
2161
2161
|
================================================================================
|
|
2162
2162
|
|
|
2163
2163
|
BSD 3-Clause License
|
|
@@ -2210,7 +2210,7 @@ TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
|
|
|
2210
2210
|
THIS SOFTWARE.
|
|
2211
2211
|
|
|
2212
2212
|
================================================================================
|
|
2213
|
-
katex 0.
|
|
2213
|
+
katex 0.18.10 (MIT): https://github.com/KaTeX/KaTeX
|
|
2214
2214
|
in the extension, the command line and the desktop app
|
|
2215
2215
|
================================================================================
|
|
2216
2216
|
|
|
@@ -2294,7 +2294,7 @@ SOFTWARE.
|
|
|
2294
2294
|
|
|
2295
2295
|
================================================================================
|
|
2296
2296
|
linkify-it 6.1.0 (MIT): https://github.com/markdown-it/linkify-it
|
|
2297
|
-
in the extension, the command line and the
|
|
2297
|
+
in the extension, the command line, the desktop app and the embeddable viewer
|
|
2298
2298
|
================================================================================
|
|
2299
2299
|
|
|
2300
2300
|
Copyright (c) 2015 Vitaly Puzrin.
|
|
@@ -2374,8 +2374,8 @@ licenses; we recommend you read them, as their terms may differ from the
|
|
|
2374
2374
|
terms above.
|
|
2375
2375
|
|
|
2376
2376
|
================================================================================
|
|
2377
|
-
markdown-it 15.0.
|
|
2378
|
-
in the extension, the command line and the
|
|
2377
|
+
markdown-it 15.0.3 (MIT): https://github.com/markdown-it/markdown-it
|
|
2378
|
+
in the extension, the command line, the desktop app and the embeddable viewer
|
|
2379
2379
|
================================================================================
|
|
2380
2380
|
|
|
2381
2381
|
Copyright (c) 2014 Vitaly Puzrin, Alex Kocharin.
|
|
@@ -2403,7 +2403,7 @@ OTHER DEALINGS IN THE SOFTWARE.
|
|
|
2403
2403
|
|
|
2404
2404
|
================================================================================
|
|
2405
2405
|
markdown-it-footnote 4.0.0 (MIT): https://github.com/markdown-it/markdown-it-footnote
|
|
2406
|
-
in the extension, the command line and the
|
|
2406
|
+
in the extension, the command line, the desktop app and the embeddable viewer
|
|
2407
2407
|
================================================================================
|
|
2408
2408
|
|
|
2409
2409
|
Copyright (c) 2014-2015 Vitaly Puzrin, Alex Kocharin.
|
|
@@ -2481,7 +2481,7 @@ This software is provided by the copyright holders and contributors “as is”
|
|
|
2481
2481
|
|
|
2482
2482
|
================================================================================
|
|
2483
2483
|
mdurl 2.1.0 (MIT): https://github.com/markdown-it/mdurl
|
|
2484
|
-
in the extension, the command line and the
|
|
2484
|
+
in the extension, the command line, the desktop app and the embeddable viewer
|
|
2485
2485
|
================================================================================
|
|
2486
2486
|
|
|
2487
2487
|
Copyright (c) 2015 Vitaly Puzrin, Alex Kocharin.
|
|
@@ -2531,7 +2531,7 @@ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
|
|
|
2531
2531
|
IN THE SOFTWARE.
|
|
2532
2532
|
|
|
2533
2533
|
================================================================================
|
|
2534
|
-
mermaid 12.
|
|
2534
|
+
mermaid 12.3.0 (MIT): https://github.com/mermaid-js/mermaid
|
|
2535
2535
|
in the extension, the command line and the desktop app
|
|
2536
2536
|
================================================================================
|
|
2537
2537
|
|
|
@@ -2559,9 +2559,9 @@ SOFTWARE.
|
|
|
2559
2559
|
|
|
2560
2560
|
================================================================================
|
|
2561
2561
|
punycode.js 2.3.1 (MIT): https://github.com/mathiasbynens/punycode.js
|
|
2562
|
-
in the extension, the command line and the
|
|
2562
|
+
in the extension, the command line, the desktop app and the embeddable viewer
|
|
2563
2563
|
uc.micro 3.0.0 (MIT): https://github.com/markdown-it/uc.micro
|
|
2564
|
-
in the extension, the command line and the
|
|
2564
|
+
in the extension, the command line, the desktop app and the embeddable viewer
|
|
2565
2565
|
================================================================================
|
|
2566
2566
|
|
|
2567
2567
|
Copyright Mathias Bynens <https://mathiasbynens.be/>
|
|
@@ -2665,18 +2665,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
|
2665
2665
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
2666
2666
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
2667
2667
|
SOFTWARE.
|
|
2668
|
-
|
|
2669
|
-
================================================================================
|
|
2670
|
-
uuid 14.0.2 (MIT): https://github.com/uuidjs/uuid
|
|
2671
|
-
in the extension, the command line and the desktop app
|
|
2672
|
-
================================================================================
|
|
2673
|
-
|
|
2674
|
-
The MIT License (MIT)
|
|
2675
|
-
|
|
2676
|
-
Copyright (c) 2010-2020 Robert Kieffer and other contributors
|
|
2677
|
-
|
|
2678
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
2679
|
-
|
|
2680
|
-
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
|
2681
|
-
|
|
2682
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|