Skip to content

Commit

Permalink
Build docs
Browse files Browse the repository at this point in the history
  • Loading branch information
finnvoor committed Mar 22, 2024
1 parent 93127c2 commit 22a5b6a
Show file tree
Hide file tree
Showing 327 changed files with 285 additions and 303 deletions.
2 changes: 1 addition & 1 deletion docs/data/documentation/playdatekit.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"abstract":[{"text":"Create games for Playdate using Swift.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/playdatekit"]}],"metadata":{"title":"PlaydateKit","symbolKind":"module","externalID":"PlaydateKit","modules":[{"name":"PlaydateKit"}],"role":"collection","images":[{"identifier":"Logo.png","type":"icon"}],"roleHeading":"Framework"},"topicSections":[{"title":"Essentials","identifiers":["doc:\/\/PlaydateKit\/tutorials\/Meet-PlaydateKit"]},{"identifiers":["doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/PlaydateGame"],"generated":true,"title":"Protocols"},{"title":"Functions","identifiers":["doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/posix_memalign(_:_:_:)"],"generated":true},{"title":"Type Aliases","identifiers":["doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Display","doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/File","doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Graphics","doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/JSON","doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Scoreboards","doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Sprite","doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/System"],"generated":true},{"title":"Enumerations","identifiers":["doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Playdate"],"generated":true},{"generated":true,"title":"Extended Modules","identifiers":["doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/CPlaydate"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit"},"sections":[],"kind":"symbol","hierarchy":{"paths":[[]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://PlaydateKit/documentation/PlaydateKit/System":{"abstract":[],"url":"\/documentation\/playdatekit\/system","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"System","kind":"identifier"}],"title":"System","type":"topic","identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/System","role":"symbol","kind":"symbol","navigatorTitle":[{"text":"System","kind":"identifier"}]},"doc://PlaydateKit/documentation/PlaydateKit/posix_memalign(_:_:_:)":{"title":"posix_memalign(_:_:_:)","identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/posix_memalign(_:_:_:)","abstract":[{"type":"text","text":"Implement "},{"type":"codeVoice","code":"posix_memalign(3)"},{"text":", which is required by the Swift runtime but is","type":"text"},{"type":"text","text":" "},{"type":"text","text":"not provided by the Playdate C library."}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"posix_memalign","kind":"identifier"},{"kind":"text","text":"("},{"text":"UnsafeMutablePointer","kind":"typeIdentifier","preciseIdentifier":"s:Sp"},{"kind":"text","text":"<"},{"text":"UnsafeMutableRawPointer","preciseIdentifier":"s:Sv","kind":"typeIdentifier"},{"text":"?>, ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":") -> "},{"text":"CInt","preciseIdentifier":"s:s4CInta","kind":"typeIdentifier"}],"kind":"symbol","url":"\/documentation\/playdatekit\/posix_memalign(_:_:_:)","role":"symbol","type":"topic"},"doc://PlaydateKit/documentation/PlaydateKit/Sprite":{"identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Sprite","url":"\/documentation\/playdatekit\/sprite","abstract":[],"role":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Sprite","kind":"identifier"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Sprite"}],"title":"Sprite","type":"topic"},"doc://PlaydateKit/documentation/PlaydateKit/Scoreboards":{"type":"topic","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"Scoreboards","kind":"identifier"}],"url":"\/documentation\/playdatekit\/scoreboards","abstract":[],"identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Scoreboards","navigatorTitle":[{"kind":"identifier","text":"Scoreboards"}],"title":"Scoreboards"},"doc://PlaydateKit/tutorials/Meet-PlaydateKit":{"role":"overview","kind":"overview","type":"topic","title":"Meet PlaydateKit","identifier":"doc:\/\/PlaydateKit\/tutorials\/Meet-PlaydateKit","abstract":[],"url":"\/tutorials\/meet-playdatekit"},"doc://PlaydateKit/documentation/PlaydateKit/Display":{"navigatorTitle":[{"kind":"identifier","text":"Display"}],"url":"\/documentation\/playdatekit\/display","role":"symbol","title":"Display","type":"topic","kind":"symbol","identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Display","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Display","kind":"identifier"}],"abstract":[]},"doc://PlaydateKit/documentation/PlaydateKit/Graphics":{"identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Graphics","url":"\/documentation\/playdatekit\/graphics","kind":"symbol","role":"symbol","type":"topic","navigatorTitle":[{"text":"Graphics","kind":"identifier"}],"fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"Graphics","kind":"identifier"}],"abstract":[],"title":"Graphics"},"doc://PlaydateKit/documentation/PlaydateKit/File":{"role":"symbol","abstract":[],"url":"\/documentation\/playdatekit\/file","title":"File","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"kind":"identifier","text":"File"}],"identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/File","type":"topic","kind":"symbol","navigatorTitle":[{"text":"File","kind":"identifier"}]},"doc://PlaydateKit/documentation/PlaydateKit/JSON":{"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"JSON","kind":"identifier"}],"type":"topic","abstract":[],"kind":"symbol","title":"JSON","url":"\/documentation\/playdatekit\/json","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"JSON"}],"identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/JSON"},"doc://PlaydateKit/documentation/PlaydateKit":{"url":"\/documentation\/playdatekit","identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit","abstract":[{"text":"Create games for Playdate using Swift.","type":"text"}],"role":"collection","kind":"symbol","images":[{"identifier":"Logo.png","type":"icon"}],"title":"PlaydateKit","type":"topic"},"doc://PlaydateKit/documentation/PlaydateKit/CPlaydate":{"identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/CPlaydate","abstract":[],"role":"collection","kind":"symbol","url":"\/documentation\/playdatekit\/cplaydate","type":"topic","title":"CPlaydate"},"doc://PlaydateKit/documentation/PlaydateKit/Playdate":{"abstract":[],"identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Playdate","title":"Playdate","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"Playdate","kind":"identifier"}],"url":"\/documentation\/playdatekit\/playdate","navigatorTitle":[{"text":"Playdate","kind":"identifier"}],"kind":"symbol","type":"topic"},"Logo.png":{"alt":null,"type":"image","identifier":"Logo.png","variants":[{"url":"\/images\/PlaydateKit\/Logo.png","traits":["1x","light"]}]},"doc://PlaydateKit/documentation/PlaydateKit/PlaydateGame":{"title":"PlaydateGame","identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/PlaydateGame","kind":"symbol","role":"symbol","url":"\/documentation\/playdatekit\/playdategame","navigatorTitle":[{"kind":"identifier","text":"PlaydateGame"}],"type":"topic","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"PlaydateGame","kind":"identifier"}],"abstract":[]}}}
{"kind":"symbol","identifier":{"url":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/playdatekit"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[[]]},"sections":[],"metadata":{"title":"PlaydateKit","roleHeading":"Framework","externalID":"PlaydateKit","role":"collection","images":[{"type":"icon","identifier":"Logo.png"}],"modules":[{"name":"PlaydateKit"}],"symbolKind":"module"},"abstract":[{"text":"Create games for Playdate using Swift.","type":"text"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"topicSections":[{"identifiers":["doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Downloading-Prerequisites","doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Building-the-Template","doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/PlaydateGame"],"title":"Getting Started"},{"title":"Essentials","identifiers":["doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Playdate\/Display","doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Playdate\/File","doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Playdate\/Graphics","doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Playdate\/JSON","doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Playdate\/Scoreboards","doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Playdate\/Sprite","doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Playdate\/System"]},{"identifiers":["doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Playdate"],"generated":true,"title":"Enumerations"},{"title":"Extended Modules","identifiers":["doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/CPlaydate"],"generated":true}],"references":{"doc://PlaydateKit/documentation/PlaydateKit/Playdate":{"role":"symbol","title":"Playdate","type":"topic","url":"\/documentation\/playdatekit\/playdate","kind":"symbol","abstract":[],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"Playdate","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Playdate"}],"identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Playdate"},"doc://PlaydateKit/documentation/PlaydateKit/Building-the-Template":{"kind":"article","type":"topic","title":"Building the Template","role":"article","url":"\/documentation\/playdatekit\/building-the-template","identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Building-the-Template","abstract":[{"type":"text","text":"This article guides you through running your first game on the Playdate simulator using Swift."}]},"doc://PlaydateKit/documentation/PlaydateKit":{"identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit","type":"topic","role":"collection","title":"PlaydateKit","kind":"symbol","images":[{"type":"icon","identifier":"Logo.png"}],"abstract":[{"type":"text","text":"Create games for Playdate using Swift."}],"url":"\/documentation\/playdatekit"},"doc://PlaydateKit/documentation/PlaydateKit/Playdate/Display":{"fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"Display","kind":"identifier"}],"identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Playdate\/Display","abstract":[{"type":"text","text":"Functions pertaining to Playdate’s screen."}],"title":"Playdate.Display","role":"symbol","url":"\/documentation\/playdatekit\/playdate\/display","type":"topic","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Display"}]},"Logo.png":{"identifier":"Logo.png","alt":null,"variants":[{"url":"\/images\/PlaydateKit\/Logo.png","traits":["1x","light"]}],"type":"image"},"doc://PlaydateKit/documentation/PlaydateKit/Playdate/Scoreboards":{"identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Playdate\/Scoreboards","url":"\/documentation\/playdatekit\/playdate\/scoreboards","role":"symbol","title":"Playdate.Scoreboards","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Scoreboards"}],"abstract":[{"text":"Functions related to fetching and updating scoreboards.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"Scoreboards"}],"kind":"symbol","type":"topic"},"doc://PlaydateKit/documentation/PlaydateKit/CPlaydate":{"type":"topic","title":"CPlaydate","kind":"symbol","role":"collection","abstract":[],"identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/CPlaydate","url":"\/documentation\/playdatekit\/cplaydate"},"doc://PlaydateKit/documentation/PlaydateKit/Playdate/Sprite":{"abstract":[{"text":"Functions related to sprites.","type":"text"}],"navigatorTitle":[{"text":"Sprite","kind":"identifier"}],"url":"\/documentation\/playdatekit\/playdate\/sprite","title":"Playdate.Sprite","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Sprite","kind":"identifier"}],"identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Playdate\/Sprite","kind":"symbol","type":"topic","role":"symbol"},"doc://PlaydateKit/documentation/PlaydateKit/Playdate/System":{"type":"topic","navigatorTitle":[{"text":"System","kind":"identifier"}],"kind":"symbol","title":"Playdate.System","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"System","kind":"identifier"}],"identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Playdate\/System","abstract":[{"text":"Functions related to menu items, peripherals, and input.","type":"text"}],"url":"\/documentation\/playdatekit\/playdate\/system","role":"symbol"},"doc://PlaydateKit/documentation/PlaydateKit/PlaydateGame":{"role":"symbol","kind":"symbol","url":"\/documentation\/playdatekit\/playdategame","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"PlaydateGame"}],"navigatorTitle":[{"kind":"identifier","text":"PlaydateGame"}],"abstract":[{"type":"text","text":"A set of methods to manage the lifecycle and events for your game."}],"type":"topic","identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/PlaydateGame","title":"PlaydateGame"},"doc://PlaydateKit/documentation/PlaydateKit/Playdate/Graphics":{"navigatorTitle":[{"text":"Graphics","kind":"identifier"}],"type":"topic","title":"Playdate.Graphics","identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Playdate\/Graphics","abstract":[{"type":"text","text":"Functions related to displaying information on the device screen."}],"url":"\/documentation\/playdatekit\/playdate\/graphics","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Graphics","kind":"identifier"}],"kind":"symbol"},"doc://PlaydateKit/documentation/PlaydateKit/Playdate/File":{"type":"topic","navigatorTitle":[{"text":"File","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Playdate\/File","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"kind":"identifier","text":"File"}],"kind":"symbol","abstract":[{"type":"text","text":"Functions which allow you to interact with files on Playdate’s filesystem."}],"url":"\/documentation\/playdatekit\/playdate\/file","title":"Playdate.File"},"doc://PlaydateKit/documentation/PlaydateKit/Downloading-Prerequisites":{"role":"article","identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Downloading-Prerequisites","title":"Downloading Prerequisites","type":"topic","abstract":[{"text":"This article guides you through downloading and installing the required tools needed to build games for Playdate using Swift.","type":"text"}],"url":"\/documentation\/playdatekit\/downloading-prerequisites","kind":"article"},"doc://PlaydateKit/documentation/PlaydateKit/Playdate/JSON":{"url":"\/documentation\/playdatekit\/playdate\/json","navigatorTitle":[{"text":"JSON","kind":"identifier"}],"type":"topic","title":"Playdate.JSON","identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Playdate\/JSON","role":"symbol","abstract":[{"type":"text","text":"Encoding and decoding of JSON files and strings."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"kind":"identifier","text":"JSON"}]}}}
Loading

0 comments on commit 22a5b6a

Please sign in to comment.