docsifyjs / docsifyjs/docsify

Friendly doc Helpers

Open
#413 7 comments 11 reactions 0 assignees View on GitHub
enhancement pr welcome ready to implement ui/ux
Dominant language
JavaScript
Stars
31.5k
Forks
5.8k
Avg merge
9d 8h
Merged PRs (30d)
2

Description

![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
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.