docsifyjs/docsify

Feature request: TOC (Table Of Contents) on the right side

Open

#1.908 aberto em 24 de out. de 2022

Ver no GitHub
 (6 comments) (2 reactions) (0 assignees)JavaScript (5.630 forks)batch import
good first Issue

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

Feature request

What problem does this feature solve?

Include a TOC (Table of Contents) section on the right side.

What does the proposed API look like?

How should this be implemented in your opinion?

The Table of contents should be autogenerated and triggered with a flag, similar to how the navigation or sidebars work. It would contain a separate file toc.md for example that would be used for styling and supplemental configuration.

It would look and work similar to how it's implemented currently for the android documentation: https://developer.android.com/games/develop/overview

Are you willing to work on this yourself?

No

Guia do colaborador

Direção de pesquisa
Explore como o Docsify gera a navegação da barra lateral e os plugins. Consulte os plugins existentes como referência. O sumário deve ser gerado automaticamente a partir dos cabeçalhos, de forma semelhante à barra lateral. Implemente um novo plugin que adiciona um sumário no lado direito, configurável por meio de um sinalizador. Consulte o exemplo da documentação do Android para estilo e comportamento. Comece entendendo a API de plugins e o processo de renderização de markdown em src/.
Pilha de tecnologia
javascriptcsshtml
Domain
documentation
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.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
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.
Principalmente claro
Prerequisites
JavaScriptCSSDocsify plugin API
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
30