docsifyjs / docsifyjs/docsify

Friendly doc Helpers

Aberta
#413 7 comentários 11 reações 0 responsáveis Ver no GitHub
enhancement pr welcome ready to implement ui/ux
Linguagem predominante
JavaScript
Estrelas
31.5k
Forks
5.8k
Merge médio
9d 8h
PRs com merge (30d)
2

Descrição

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

Guia de contribuição

Abrir o guia de contribuição

Direção de pesquisa

Nenhum arquivo ou teste é mencionado. Comece localizando a implementação existente dos helpers [!] e [?] e, em seguida, acompanhe como os blockquotes de Markdown são renderizados. A tarefa estará concluída quando a sintaxe [v], [x] e [detail] for renderizada de forma consistente com os exemplos propostos e estiver coberta pelos testes relevantes do projeto.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
javascript, markdown
Domínio
documentation
Tipo de issue
Funcionalidade
Dificuldade
4/5
Tempo estimado
3-5 dias
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
32/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.