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

Ouverte
#7,645 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
5/5
Temps estimé
Plus d'une semaine
Accessibilité débutants
30/100
Type d'issue
Refactorisation
Clarté
À clarifier
Activité
À l'abandon
Stack technique
markdown
Domaine
documentation

Piste de recherche

Commencez par examiner comment la documentation existante est répartie entre plusieurs fichiers .html pour chaque page et comment ces fichiers sont générés. Définissez une approche de migration afin que chaque page puisse être modifiée dans un seul fichier .md, tout en préservant le contenu et la sortie de la documentation existante.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.

Langage dominant
JavaScript
Étoiles
18.3k
Forks
2k
Merge moyen
2 j 12 h
PR mergées (30 j)
28

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de plotly/plotly.js

Toutes les issues de plotly/plotly.js

Issues similaires

Plus d'issues JavaScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.