Make Complete How-to from Running Hyde, Writing Documentation to Serving in Jekyll
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 35/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- jekyll
- Ambito
- documentation
Direzione di ricerca
Parti dal workflow esistente di build di Hyde e di pubblicazione tramite Jekyll descritto nell’issue, concentrandoti su come il Markdown generato da Hyde viene passato a Jekyll. Un tutorial completo dovrebbe mostrare come documentare metodi e classi C++, eseguire Hyde e pubblicare la documentazione risultante tramite Jekyll.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Dear Authors.
I am very interested in documenting my C++ code in a different approach than the normal "XML/Doxygen inline" mess and as such have found Hyde. Unfortunately, I have a hard time using Hyde in conjunction with Jekyll.
I have build and run Hyde just fine, installed and served Jekyll fine, but still I dont know how to actually serve the markdown generated by Hyde and how to write documentation on the methods.
I would suggest a full end to end example on how to document code.
If somebody can help me getting to actually serve documentation with Jekyll with method and class codumentation written by me, I will be happy to write such a tutorial.
- Lingua principale
- C++
- Stelle
- 341
- Fork
- 45
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
- Include un Dockerfile o un file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di adobe/hyde
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 35/100
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 25/100
-
Better owner managementAperta
Difficoltà 5/5 Più di una settimana Idoneità per principianti 15/100
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
Issue simili
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
I maintainer di solito rispondono entro 3 giorni
-
test(tools): two testkit cache tests fail unless GOCACHE and GOMODCACHE are in the environmentApertabacklog
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
EchoTools/nevr-runtime#2385 ·
I maintainer di solito rispondono entro 1 giorno
-
type:bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
tensorflow/tflite-micro#3995 ·
I maintainer di solito rispondono entro 1 giorno
-
CPU update 1.31xApertaspeed-report
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 75/100
mw00/project-maya#961 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100