markdown-design-doc-viewer 1.4.1 → 1.5.1

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 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` や置き場所の誤ったマーカーなどの紐付けの警告、適用できない表のオプション、何にも一致しないワイヤーフレームのパーツのセレクタ(`item.<番号>=`))があれば失敗にする。紐付いていないだけの矢印・見出しでは失敗しない |
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` or a misplaced marker), 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. |
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`). |
@@ -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 and the desktop app; each is listed
4
- with what it is bundled in, its license and its repository, where its source code is available (also on npm).
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 desktop app
1183
+ in the extension, the command line, the desktop app and the embeddable viewer
1183
1184
  ================================================================================
1184
1185
 
1185
1186
  BSD 3-Clause License
@@ -1214,7 +1215,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1214
1215
 
1215
1216
  ================================================================================
1216
1217
  dompurify 3.4.17 (MPL-2.0 OR Apache-2.0): https://github.com/cure53/DOMPurify
1217
- in the extension, the command line and the desktop app
1218
+ in the extension, the command line, the desktop app and the embeddable viewer
1218
1219
  ================================================================================
1219
1220
 
1220
1221
  --- LICENSE ---
@@ -2068,7 +2069,7 @@ in the Eclipse Public License, v. 2.0 are satisfied: GNU General Public License
2068
2069
 
2069
2070
  ================================================================================
2070
2071
  entities 8.1.0 (BSD-2-Clause): https://github.com/fb55/entities
2071
- in the extension, the command line and the desktop app
2072
+ in the extension, the command line, the desktop app and the embeddable viewer
2072
2073
  ================================================================================
2073
2074
 
2074
2075
  Copyright (c) Felix Böhm
@@ -2156,7 +2157,7 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
2156
2157
 
2157
2158
  ================================================================================
2158
2159
  highlight.js 11.12.0 (BSD-3-Clause): https://github.com/highlightjs/highlight.js
2159
- in the extension, the command line and the desktop app
2160
+ in the extension, the command line, the desktop app and the embeddable viewer
2160
2161
  ================================================================================
2161
2162
 
2162
2163
  BSD 3-Clause License
@@ -2293,7 +2294,7 @@ SOFTWARE.
2293
2294
 
2294
2295
  ================================================================================
2295
2296
  linkify-it 6.1.0 (MIT): https://github.com/markdown-it/linkify-it
2296
- in the extension, the command line and the desktop app
2297
+ in the extension, the command line, the desktop app and the embeddable viewer
2297
2298
  ================================================================================
2298
2299
 
2299
2300
  Copyright (c) 2015 Vitaly Puzrin.
@@ -2374,7 +2375,7 @@ terms above.
2374
2375
 
2375
2376
  ================================================================================
2376
2377
  markdown-it 15.0.3 (MIT): https://github.com/markdown-it/markdown-it
2377
- in the extension, the command line and the desktop app
2378
+ in the extension, the command line, the desktop app and the embeddable viewer
2378
2379
  ================================================================================
2379
2380
 
2380
2381
  Copyright (c) 2014 Vitaly Puzrin, Alex Kocharin.
@@ -2402,7 +2403,7 @@ OTHER DEALINGS IN THE SOFTWARE.
2402
2403
 
2403
2404
  ================================================================================
2404
2405
  markdown-it-footnote 4.0.0 (MIT): https://github.com/markdown-it/markdown-it-footnote
2405
- in the extension, the command line and the desktop app
2406
+ in the extension, the command line, the desktop app and the embeddable viewer
2406
2407
  ================================================================================
2407
2408
 
2408
2409
  Copyright (c) 2014-2015 Vitaly Puzrin, Alex Kocharin.
@@ -2480,7 +2481,7 @@ This software is provided by the copyright holders and contributors “as is”
2480
2481
 
2481
2482
  ================================================================================
2482
2483
  mdurl 2.1.0 (MIT): https://github.com/markdown-it/mdurl
2483
- in the extension, the command line and the desktop app
2484
+ in the extension, the command line, the desktop app and the embeddable viewer
2484
2485
  ================================================================================
2485
2486
 
2486
2487
  Copyright (c) 2015 Vitaly Puzrin, Alex Kocharin.
@@ -2558,9 +2559,9 @@ SOFTWARE.
2558
2559
 
2559
2560
  ================================================================================
2560
2561
  punycode.js 2.3.1 (MIT): https://github.com/mathiasbynens/punycode.js
2561
- in the extension, the command line and the desktop app
2562
+ in the extension, the command line, the desktop app and the embeddable viewer
2562
2563
  uc.micro 3.0.0 (MIT): https://github.com/markdown-it/uc.micro
2563
- in the extension, the command line and the desktop app
2564
+ in the extension, the command line, the desktop app and the embeddable viewer
2564
2565
  ================================================================================
2565
2566
 
2566
2567
  Copyright Mathias Bynens <https://mathiasbynens.be/>