adobe / adobe/ops-cli

Add gh-pages based docs

Offen
#76 0 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
Python
Sterne
203
Forks
39
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne mit README.md und vergleiche anschließend die vorgeschlagenen Optionen Jekyll, MkDocs und Hugo, um die bestehende Dokumentation als auf gh-pages basierende Website zu strukturieren. Erledigt ist die Aufgabe, wenn ein Site-Generator ausgewählt wurde, die Dokumentation über das einzelne README hinaus organisiert ist und über gh-pages verfügbar ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
hugo, jekyll
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.