elastic / elastic/docs-builder-example

Lines breaks

オープン
#7 コメント 3 件 リアクション 0 件 担当者 0 名 GitHub で見る
主要言語
言語のデータがありません
スター
2
フォーク
6
PR マージ指標
30日以内にマージされた PR はありません

説明

The line breaks work differently than I expected. Per https://github.com/elastic/docs-builder-example/blob/main/docs/source/markup/sundries.md#line-breaks "You can break a paraghraph
using \ at the end of a line."

However when I cut and paste content from the elasticsearch repo, where it seems it was assumed that you had to have a defined line length and content wraps despite that, those EOL were appearing as-is in my output. For example:

```
The latest stable version of {{es}} can be found on the
[Download {{es}}](https://www.elastic.co/downloads/elasticsearch) page. Other
versions can be found on the [Past Releases page](https://www.elastic.co/downloads/past-releases).
```

![Image](https://github.com/user-attachments/assets/8a220ab4-ccb5-47bd-afa3-1ecc7b1a4f0e)

If this is working as designed I think we need to be very clear in the style guide info that what you see in your source file is exactly what appears in the output where line breaks are concerned.

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

調査の方向性

まず、リンク先の docs/source/markup/sundries.md にある改行セクションを読み、次に、そこに記載されているバックスラッシュの動作を、貼り付けられた折り返しテキストの例および添付された出力と比較します。ソースの改行の意図された扱いが確認され、ソースの折り返しがレンダリングされた出力に現れるかどうかがスタイルガイドの指針で明確に説明されていれば完了です。

索引モデルが issue の本文から書いたものです。

評価

領域
documentation
issue の種類
ドキュメント
難易度
2/5
見積もり時間
1〜3時間
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。