From 8b51b58300e5297aedadbaa92945e31721085191 Mon Sep 17 00:00:00 2001 From: Brian Beck Date: Fri, 17 Mar 2017 21:52:47 -0700 Subject: [PATCH] Render list as markdown in
element --- docs/types.md | 185 ++++++++++++++++++++-------------------- scripts/render-types.js | 27 +++--- 2 files changed, 104 insertions(+), 108 deletions(-) diff --git a/docs/types.md b/docs/types.md index e29292e..0e5af94 100644 --- a/docs/types.md +++ b/docs/types.md @@ -2,99 +2,98 @@ You may also be interested in reading the [schema in GraphQL syntax](schema.md). -
Table of Contents

    -
  • [Query](#query)
    • -
  • [Objects](#objects)
      -
    • [Alias](#alias)
      • -
    • [Area](#area)
      • -
    • [AreaConnection](#areaconnection)
      • -
    • [AreaEdge](#areaedge)
      • -
    • [Artist](#artist)
      • -
    • [ArtistConnection](#artistconnection)
      • -
    • [ArtistCredit](#artistcredit)
      • -
    • [ArtistEdge](#artistedge)
      • -
    • [BrowseQuery](#browsequery)
      • -
    • [Collection](#collection)
      • -
    • [CollectionConnection](#collectionconnection)
      • -
    • [CollectionEdge](#collectionedge)
      • -
    • [Coordinates](#coordinates)
      • -
    • [CoverArtImage](#coverartimage)
      • -
    • [CoverArtImageThumbnails](#coverartimagethumbnails)
      • -
    • [Disc](#disc)
      • -
    • [Event](#event)
      • -
    • [EventConnection](#eventconnection)
      • -
    • [EventEdge](#eventedge)
      • -
    • [Instrument](#instrument)
      • -
    • [InstrumentConnection](#instrumentconnection)
      • -
    • [InstrumentEdge](#instrumentedge)
      • -
    • [Label](#label)
      • -
    • [LabelConnection](#labelconnection)
      • -
    • [LabelEdge](#labeledge)
      • -
    • [LifeSpan](#lifespan)
      • -
    • [LookupQuery](#lookupquery)
      • -
    • [Medium](#medium)
      • -
    • [PageInfo](#pageinfo)
      • -
    • [Place](#place)
      • -
    • [PlaceConnection](#placeconnection)
      • -
    • [PlaceEdge](#placeedge)
      • -
    • [Rating](#rating)
      • -
    • [Recording](#recording)
      • -
    • [RecordingConnection](#recordingconnection)
      • -
    • [RecordingEdge](#recordingedge)
      • -
    • [Relationship](#relationship)
      • -
    • [RelationshipConnection](#relationshipconnection)
      • -
    • [RelationshipEdge](#relationshipedge)
      • -
    • [Relationships](#relationships)
      • -
    • [Release](#release)
      • -
    • [ReleaseConnection](#releaseconnection)
      • -
    • [ReleaseCoverArt](#releasecoverart)
      • -
    • [ReleaseEdge](#releaseedge)
      • -
    • [ReleaseEvent](#releaseevent)
      • -
    • [ReleaseGroup](#releasegroup)
      • -
    • [ReleaseGroupConnection](#releasegroupconnection)
      • -
    • [ReleaseGroupCoverArt](#releasegroupcoverart)
      • -
    • [ReleaseGroupEdge](#releasegroupedge)
      • -
    • [SearchQuery](#searchquery)
      • -
    • [Series](#series)
      • -
    • [SeriesConnection](#seriesconnection)
      • -
    • [SeriesEdge](#seriesedge)
      • -
    • [Tag](#tag)
      • -
    • [TagConnection](#tagconnection)
      • -
    • [TagEdge](#tagedge)
      • -
    • [URL](#url)
      • -
    • [Work](#work)
      • -
    • [WorkConnection](#workconnection)
      • -
    • [WorkEdge](#workedge)
      • -
    • -
  • [Enums](#enums)
      -
    • [CoverArtImageSize](#coverartimagesize)
      • -
    • [ReleaseGroupType](#releasegrouptype)
      • -
    • [ReleaseStatus](#releasestatus)
      • -
    • -
  • [Scalars](#scalars)
      -
    • [ASIN](#asin)
      • -
    • [Boolean](#boolean)
      • -
    • [Date](#date)
      • -
    • [Degrees](#degrees)
      • -
    • [DiscID](#discid)
      • -
    • [Duration](#duration)
      • -
    • [ID](#id)
      • -
    • [IPI](#ipi)
      • -
    • [ISNI](#isni)
      • -
    • [ISRC](#isrc)
      • -
    • [ISWC](#iswc)
      • -
    • [Int](#int)
      • -
    • [Locale](#locale)
      • -
    • [MBID](#mbid)
      • -
    • [String](#string)
      • -
    • [Time](#time)
      • -
    • [URLString](#urlstring)
      • -
    • -
  • [Interfaces](#interfaces)
      -
    • [Entity](#entity)
      • -
    • [Node](#node)
      • -
    • -

+
+ Table of Contents + + * [Query](#query) + * [Objects](#objects) + * [Alias](#alias) + * [Area](#area) + * [AreaConnection](#areaconnection) + * [AreaEdge](#areaedge) + * [Artist](#artist) + * [ArtistConnection](#artistconnection) + * [ArtistCredit](#artistcredit) + * [ArtistEdge](#artistedge) + * [BrowseQuery](#browsequery) + * [Collection](#collection) + * [CollectionConnection](#collectionconnection) + * [CollectionEdge](#collectionedge) + * [Coordinates](#coordinates) + * [CoverArtImage](#coverartimage) + * [CoverArtImageThumbnails](#coverartimagethumbnails) + * [Disc](#disc) + * [Event](#event) + * [EventConnection](#eventconnection) + * [EventEdge](#eventedge) + * [Instrument](#instrument) + * [InstrumentConnection](#instrumentconnection) + * [InstrumentEdge](#instrumentedge) + * [Label](#label) + * [LabelConnection](#labelconnection) + * [LabelEdge](#labeledge) + * [LifeSpan](#lifespan) + * [LookupQuery](#lookupquery) + * [Medium](#medium) + * [PageInfo](#pageinfo) + * [Place](#place) + * [PlaceConnection](#placeconnection) + * [PlaceEdge](#placeedge) + * [Rating](#rating) + * [Recording](#recording) + * [RecordingConnection](#recordingconnection) + * [RecordingEdge](#recordingedge) + * [Relationship](#relationship) + * [RelationshipConnection](#relationshipconnection) + * [RelationshipEdge](#relationshipedge) + * [Relationships](#relationships) + * [Release](#release) + * [ReleaseConnection](#releaseconnection) + * [ReleaseCoverArt](#releasecoverart) + * [ReleaseEdge](#releaseedge) + * [ReleaseEvent](#releaseevent) + * [ReleaseGroup](#releasegroup) + * [ReleaseGroupConnection](#releasegroupconnection) + * [ReleaseGroupCoverArt](#releasegroupcoverart) + * [ReleaseGroupEdge](#releasegroupedge) + * [SearchQuery](#searchquery) + * [Series](#series) + * [SeriesConnection](#seriesconnection) + * [SeriesEdge](#seriesedge) + * [Tag](#tag) + * [TagConnection](#tagconnection) + * [TagEdge](#tagedge) + * [URL](#url) + * [Work](#work) + * [WorkConnection](#workconnection) + * [WorkEdge](#workedge) + * [Enums](#enums) + * [CoverArtImageSize](#coverartimagesize) + * [ReleaseGroupType](#releasegrouptype) + * [ReleaseStatus](#releasestatus) + * [Scalars](#scalars) + * [ASIN](#asin) + * [Boolean](#boolean) + * [Date](#date) + * [Degrees](#degrees) + * [DiscID](#discid) + * [Duration](#duration) + * [ID](#id) + * [IPI](#ipi) + * [ISNI](#isni) + * [ISRC](#isrc) + * [ISWC](#iswc) + * [Int](#int) + * [Locale](#locale) + * [MBID](#mbid) + * [String](#string) + * [Time](#time) + * [URLString](#urlstring) + * [Interfaces](#interfaces) + * [Entity](#entity) + * [Node](#node) + +
## Query The query root, from which multiple types of MusicBrainz diff --git a/scripts/render-types.js b/scripts/render-types.js index 9c8cbf2..ca37de6 100644 --- a/scripts/render-types.js +++ b/scripts/render-types.js @@ -93,29 +93,26 @@ console.log('# Schema Types\n') console.log('You may also be interested in reading the [schema in GraphQL syntax](schema.md).\n') -console.log('
Table of Contents

    ') -console.log('
  • [Query](#query)
    • ') -console.log('
  • [Objects](#objects)
      ') +console.log('
      ') +console.log(' Table of Contents\n') +console.log(' * [Query](#query)') +console.log(' * [Objects](#objects)') objects.forEach(type => { - console.log(`
    • [${type.name}](#${type.name.toLowerCase()})
      • `) + console.log(` * [${type.name}](#${type.name.toLowerCase()})`) }) -console.log('
    • ') -console.log('
  • [Enums](#enums)
      ') +console.log(' * [Enums](#enums)') enums.forEach(type => { - console.log(`
    • [${type.name}](#${type.name.toLowerCase()})
      • `) + console.log(` * [${type.name}](#${type.name.toLowerCase()})`) }) -console.log('
    • ') -console.log('
  • [Scalars](#scalars)
      ') +console.log(' * [Scalars](#scalars)') scalars.forEach(type => { - console.log(`
    • [${type.name}](#${type.name.toLowerCase()})
      • `) + console.log(` * [${type.name}](#${type.name.toLowerCase()})`) }) -console.log('
    • ') -console.log('
  • [Interfaces](#interfaces)
      ') +console.log(' * [Interfaces](#interfaces)') interfaces.forEach(type => { - console.log(`
    • [${type.name}](#${type.name.toLowerCase()})
      • `) + console.log(` * [${type.name}](#${type.name.toLowerCase()})`) }) -console.log('
    • ') -console.log('

') +console.log('\n
') console.log(`\n## Query ${query.name === 'Query' ? '' : '(' + query.name + ')'}`) renderObject(query, { skipTitle: true })