google/comprehensive-rust

Add structured data to generated pages

Open

#1.142 aberto em 31 de ago. de 2023

Ver no GitHub
 (1 comment) (0 reactions) (0 assignees)Rust (2.009 forks)batch import
enhancementgood first issuehelp wanted

Métricas do repositório

Stars
 (32.954 stars)
Métricas de merge de PR
 (Mesclagem média 9d 23h) (36 fundiu PRs em 30d)

Description

We should look into adding structured data to the generated HTML.

I imagine this could be metadata about each page:

  • title, though this is probably covered fine with the title element,
  • when was the page last changed (look this up in Git),
  • place in the page hierarchy,

It seems there is special vocabulary available which might be interesting for us:

How to do this? Likely with a new mdbook preprocessor which can inject the data into the publishing pipeline.

Guia do colaborador

Direção de pesquisa
Explore os pré processadores mdbook existentes para entender a API e como injetar JSON LD no HTML gerado. Consulte a documentação do mdbook para criar pré processadores personalizados. Considere os tipos específicos de dados estruturados mencionados: Breadcrumb, Course, SitelinksSearchBox. Teste com um pré processador simples que adiciona um bloco JSON LD estático para verificar se o pipeline funciona, depois implemente a extração dinâmica de dados (por exemplo, hierarquia de páginas, data da última modificação do Git). A issue tem um comentário que pode fornecer orientação adicional.
Pilha de tecnologia
rust
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.
3-5 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
Rustmdbook
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
50