docsifyjs/docsify

when onlyCover is true, also provide an option to show the menu.

Open

#1.249 aberto em 26 de jun. de 2020

Ver no GitHub
 (0 comments) (4 reactions) (0 assignees)JavaScript (5.630 forks)batch import
enhancementgood first Issuepr welcomesemver-minor

Métricas do repositório

Stars
 (26.454 stars)
Métricas de merge de PR
 (Mesclagem média 18d 16h) (9 fundiu PRs em 30d)

Description

Continuing from https://github.com/docsifyjs/docsify/issues/1173#event-3485443350

Feature request

When only onlyCover is true, it would be great to have an option to show the menu (and of course the menu should not be empty).

What problem does this feature solve?

Allows people to skip to content faster.

What does the proposed API look like?

window.$docsify = {
  onlyCover: true,
  onlyCoverShowMenu: true, // false by default
}

Guia do colaborador

Direção de pesquisa
Analise o código fonte do Docsify para localizar o tratamento da opção de configuração `onlyCover`, provavelmente nos arquivos JavaScript principais. Identifique onde a lógica de renderização da página de capa e do menu é controlada. Adicione uma nova opção `onlyCoverShowMenu` que, quando `true`, exibe o menu mesmo quando `onlyCover` for true. Certifique se de que o padrão seja `false` para manter a compatibilidade com versões anteriores.
Pilha de tecnologia
javascript
Domain
frontend
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Familiarity with Docsify configurationJavaScript basics
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85