docsifyjs / docsifyjs/docsify

Friendly doc Helpers

オープン
#413 コメント 7 件 リアクション 11 件 担当者 0 名 GitHub で見る
enhancement pr welcome ready to implement ui/ux
主要言語
JavaScript
スター
31.5k
フォーク
5.8k
平均マージ
9日 8時間
マージ済み PR(30日)
2

説明

![status](https://img.shields.io/badge/Status-Ready%20to%20Implement-brightgreen) ![PR](https://img.shields.io/badge/PR-Welcome-green)

- Considering this as well https://github.com/docsifyjs/docsify/issues/413#issuecomment-395293929. ( @jhildenbiddle 's thoughts ?)

---

docsify extends Markdown syntax to make your documents more readable.

```markdown
> [!] **Time** is money, my friend!
```

In Markdown

> [!] **Time** is money, my friend!

In docsify

![image](https://user-images.githubusercontent.com/7565692/37012669-ce73c2ce-2130-11e8-9a4a-813e23fd3204.png)

------

```markdown
> [?] _TODO_ unit test
```

In Markdown

> [?] _TODO_ unit test

In docsify

![image](https://user-images.githubusercontent.com/7565692/37012686-e4028f26-2130-11e8-9704-6e645d51da98.png)

----

## New helpers

```markdown
> [v] Good
```

```markdown
> [x] Bad
```

```markdown
> [detail] summary
> detail detail deatail
> xxxx
```

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

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

調査の方向性

No files or tests are named. Start by locating the existing implementation for the [!] and [?] helpers, then trace how Markdown blockquotes are rendered. Done means [v], [x], and [detail] syntax render consistently with the proposed examples and are covered by the project's relevant tests.

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

評価

技術スタック
javascript, markdown
領域
documentation
issue の種類
機能追加
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
32/100

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

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