Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

Proposal: Add options to use pre-processed content with `beforeEach` function

Aberta
  • Algo errado?
#1,898 1 comentário 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 8 dias

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
25/100
Tipo de issue
Funcionalidade
Clareza
Precisa de esclarecimento
Status de atividade
Estagnada
Stack de tecnologia
javascript
Domínio
tooling

Direção de pesquisa

Comece revisando as etapas de renderização do docsify e sua integração com o Marked e, em seguida, discuta o ciclo de vida proposto com os mantenedores do projeto, pois a issue não especifica uma API nem um local de implementação. O trabalho será considerado concluído quando houver um hook de pré-processamento não incompatível com versões anteriores, um comportamento documentado e testes cobrindo a ordem de processamento dos plugins e a reutilização do conteúdo pré-processado.

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

Descrição

Feature request

What problem does this feature solve?

For plugins, we have to do some pre-processing tasks, for example, we always need to ignore the code blocks, then start the processing of our plugins.
If this function not provided by docsify itself officially, then each plugin need to handle it by themselves, for users who want included many plugins, those pre-processing tasks will be executed repeatedly, which will affect the performance for loading pages.

What does the proposed API look like?

Haven't yet considered welly, but might can consider adding something like afterEachXXX for each stage of processing the markdown content, like afterEachCodeHandled.
I hope it should be a “new feature”, rather than a “break change”.

How should this be implemented in your opinion?

Haven't yet considered welly, waiting for project members to discuss this proposal, since docsify does not handle the render stages by itself other than using Marked.

Are you willing to work on this yourself?

Might will have some time to do this, but need helps and advices.

Linguagem predominante
JavaScript
Estrelas
31.5k
Forks
5.8k
Merge médio
7d 18h
PRs com merge (30d)
9

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de docsifyjs/docsify

Todas as issues de docsifyjs/docsify

Issues semelhantes

Mais issues de JavaScript

Receba novas issues na sua caixa de entrada

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