Place example code file in collapsible sections
I maintainer di solito rispondono entro 1 giorno
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 50/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- hugo
- Ambito
- documentation
Direzione di ricerca
Esamina le pagine di esempio per service e DNS, quindi traccia il modo in cui vengono visualizzati più file di codice di esempio. L’issue suggerisce di iniziare da layouts/shortcodes/details.html e dal details shortcode fornito. Il lavoro è completato quando ogni file consecutivo appare nella propria sezione compressa, intitolata con il nome del file, e tutte le sezioni sono compresse per impostazione predefinita.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Is your feature request related to a problem? Please describe.
Some examples in the Score example hub contain several example files which are shown inline one after another. Due to some of them being rather extensive, this makes it somewhat difficult to navigate the page and see what's available on it.
E.g. here:
- Multiple Score files: https://docs.score.dev/examples/score/resources/community-provisioners/service/
- Multiple code examples: https://docs.score.dev/examples/score/resources/community-provisioners/dns/
Describe the solution you'd like
Enhance the page rendering so that any time more than one example code file is being shown back to back, all of them are placed in a collapsible section for each file. The section has the name of the file as its title.
By default, i.e. when the page is opened, all sections are collapsed.
Additional context
This Hugo shortcode may serve as a starting point:
<details{{ with .Get 1 }} {{ . | safeHTML }}{{ end -}}>
<summary>{{ with .Get 0 -}}{{ . | safeHTML }}{{ else -}}{{ errorf "No summary provided"}}{{ end -}}</summary>
{{ with .Inner -}}{{ . | markdownify}}{{ else -}}{{ errorf "No details provided"}}{{ end -}}
</details>
When placed in layouts/shortcodes/details.html, it can then be used on a page like this:
{{% details "the section title goes here" %}}
... some content
{{% /details %}}
- Lingua principale
- HTML
- Stelle
- 7
- Fork
- 27
- Merge medio
- 10h 17m
- PR unite (30g)
- 10
Preparare l'ambiente
Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.
- 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 score-spec/docs
-
Move `/docs/examples` under the new Examples Hub structure and associated process as `/examples/use-cases`Forse di nuovo libera @mathieu-benoit l’ha presa 469 giorni fa e non c’è nessuna pull request aperta. Apertadocumentation enhancement
score-spec/docs#198 · 1 commento · 1 assegnatario ·
I maintainer di solito rispondono entro 1 giorno
-
"How to write a custom provisioner?" docForse di nuovo libera @astromechza l’ha presa 639 giorni fa e non c’è nessuna pull request aperta. Apertadocumentation
score-spec/docs#121 · 7 commenti · 1 assegnatario ·
I maintainer di solito rispondono entro 1 giorno
Tutte le issue di score-spec/docs
Issue simili
-
Check Trellix Links...Aperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 88/100
NetAppDocs/ontap#2151 ·
-
documentation
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 85/100
nf-core/metaboigniter#132 ·
I maintainer di solito rispondono entro 1 giorno
-
documentation hacktoberfest priority: low skill: good first issue status: ready for dev
Difficoltà 2/5 Mezza giornata Idoneità per principianti 85/100
hyperledger-labs/fabric-smart-client#2142 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
-
netbox status: needs owner type: documentation
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 75/100
netbox-community/netbox#23412 · 1 reazione ·
I maintainer di solito rispondono entro 1 giorno