[mkdocs] - explore how to move away from multiple .html files to just one .md file per page

Aberta
#7,645 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
30/100
Tipo de issue
Refatoração
Clareza
Precisa de esclarecimento
Status de atividade
Estagnada
Stack de tecnologia
markdown
Domínio
documentation

Direção de pesquisa

Comece analisando como a documentação existente é dividida em vários arquivos .html para cada página e como esses arquivos são gerados. Defina uma abordagem de migração para que cada página possa ser editada em um único arquivo .md, preservando o conteúdo e a saída da documentação existente.

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

Descrição

We should move away from having .html files as the files that you edit to make changes to the docs. Ideally to edit the docs you'd edit a .md file and everything for a specific page is in the one .md file.

Having multiple html files for one page like we have in our existing docs, makes it challenging to create new content and edit existing content.

Linguagem predominante
JavaScript
Estrelas
18.3k
Forks
2k
Merge médio
2d 12h
PRs com merge (30d)
28

Guia de contribuição

Abrir o guia de contribuição

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 plotly/plotly.js

Todas as issues de plotly/plotly.js

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.