adobe / adobe/ops-cli

Add gh-pages based docs

Ouverte
#76 0 commentaires 1 réaction 0 personnes assignées Voir sur GitHub
Langage dominant
Python
Étoiles
203
Forks
39
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

README.md grew large so it would be useful to structure the docs in a gh-pages based site.
We can use: [jekyll](https://jekyllrb.com/), [mkdocs](https://www.mkdocs.org/) or [hugo](https://gohugo.io/documentation/) as doc site generator

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par README.md, puis comparez les options proposées Jekyll, MkDocs et Hugo pour structurer la documentation existante sous la forme d’un site basé sur gh-pages. Le travail est considéré comme terminé lorsqu’un générateur de site a été sélectionné, que la documentation est organisée au-delà du README unique et qu’elle est disponible via gh-pages.

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

Évaluation

Stack technique
hugo, jekyll
Domaine
documentation
Type d'issue
Documentation
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

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