Allow output to be configurable

Aperta
  • Qualcosa non va?
#112 2 commenti 3 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
javascript
Ambito
documentation

Direzione di ricerca

Inizia tracciando come viene generata l’attuale sezione di header e come viene configurato l’input dei comandi. Determina la struttura di configurazione supportata per disabilitare le sezioni e selezionare un layout alternativo dell’header, quindi verifica che gli esempi documentati producano l’output Markdown previsto. L’issue non indica file di implementazione né test, quindi questi punti di ingresso devono essere identificati per primi.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Looking at things like the header section I can see how it would be useful once it's clear what each heading means (It took me a few minutes to work out how "Abstract" and "Extensible" are defined for example).

It could be useful for those looking for simple output, to allow things like the header to be configurabally turned off.

I can see how a number of other elements may want to be configurable, so I'd suggest something like a jsonschema2md.rc file.

{
  "config": {
    "sections": {
      "header": false
    }
  },
  "meta": {
    "authors": [
      {
        "name": "Mr Test"
      }
    ]
  }
}

or for alternate header layout, assuming the current layout is "table"...

{
  "config": {
    "sections": {
      "header": {
        "layout": "list"
      }
    }
  }
}

Does this sound reasonable?

If so, I'll begin work on making this happen.

Lingua principale
JavaScript
Stelle
724
Fork
151
Merge medio
13h 49m
PR unite (30g)
5

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di adobe/jsonschema2md

Tutte le issue di adobe/jsonschema2md

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.