Deploying to gh-pages from @ d1c11e3 🚀

.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+/build
+/.build
+/.swiftpm
+/*.xcodeproj

main/data/documentation/file.json

@@ -0,0 +1 @@
+{"variants":[{"paths":["\/documentation\/file"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"identifier":{"url":"doc:\/\/File\/documentation\/File","interfaceLanguage":"swift"},"topicSections":[{"title":"Articles","identifiers":["doc:\/\/File\/documentation\/File\/GettingStarted"],"generated":true},{"title":"Classes","identifiers":["doc:\/\/File\/documentation\/File\/Store"]},{"title":"Protocols","identifiers":["doc:\/\/File\/documentation\/File\/FileSystem"]},{"title":"Structures","identifiers":["doc:\/\/File\/documentation\/File\/File","doc:\/\/File\/documentation\/File\/Folder","doc:\/\/File\/documentation\/File\/Path"]},{"title":"Enumerations","identifiers":["doc:\/\/File\/documentation\/File\/FileError","doc:\/\/File\/documentation\/File\/PLFileType"]}],"kind":"symbol","metadata":{"roleHeading":"Framework","externalID":"File","title":"File","symbolKind":"module","role":"collection","modules":[{"name":"File"}]},"hierarchy":{"paths":[[]]},"references":{"doc://File/documentation/File/FileSystem":{"role":"symbol","title":"FileSystem","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"FileSystem"}],"abstract":[{"type":"text","text":"Can use the functions of the file system as a key feature of PLFile."}],"identifier":"doc:\/\/File\/documentation\/File\/FileSystem","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"FileSystem"}],"url":"\/documentation\/file\/filesystem"},"doc://File/documentation/File/Folder":{"role":"symbol","title":"Folder","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Folder"}],"abstract":[{"type":"text","text":"Folder functionality in PLFile"}],"identifier":"doc:\/\/File\/documentation\/File\/Folder","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Folder"}],"url":"\/documentation\/file\/folder"},"doc://File/documentation/File":{"role":"collection","title":"File","abstract":[],"identifier":"doc:\/\/File\/documentation\/File","kind":"symbol","type":"topic","url":"\/documentation\/file"},"doc://File/documentation/File/GettingStarted":{"role":"article","title":"Getting started","abstract":[{"type":"text","text":"Learn how to use PLFile."}],"identifier":"doc:\/\/File\/documentation\/File\/GettingStarted","kind":"article","type":"topic","url":"\/documentation\/file\/gettingstarted"},"doc://File/documentation/File/Path":{"role":"symbol","title":"Path","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Path"}],"abstract":[{"type":"text","text":"Manage the path of the PLFile."}],"identifier":"doc:\/\/File\/documentation\/File\/Path","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Path"}],"url":"\/documentation\/file\/path"},"doc://File/documentation/File/Store":{"role":"symbol","title":"Store","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Store"}],"abstract":[{"type":"text","text":"A common part of the File and Folder functionality that allows you to set up the required paths and FileManager that the file system should use."}],"identifier":"doc:\/\/File\/documentation\/File\/Store","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Store"}],"url":"\/documentation\/file\/store"},"doc://File/documentation/File/FileError":{"role":"symbol","title":"FileError","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"FileError"}],"abstract":[{"type":"text","text":"Error can be thrown by PLFile"}],"identifier":"doc:\/\/File\/documentation\/File\/FileError","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"FileError"}],"url":"\/documentation\/file\/fileerror"},"doc://File/documentation/File/File":{"role":"symbol","title":"File","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"File"}],"abstract":[{"type":"text","text":"File functionality in PLFile"}],"identifier":"doc:\/\/File\/documentation\/File\/File","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"File"}],"url":"\/documentation\/file\/file"},"doc://File/documentation/File/PLFileType":{"role":"symbol","title":"PLFileType","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PLFileType"}],"abstract":[{"type":"text","text":"The type of a file or folder."}],"identifier":"doc:\/\/File\/documentation\/File\/PLFileType","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"PLFileType"}],"url":"\/documentation\/file\/plfiletype"}}}

main/data/documentation/file/file.json

@@ -0,0 +1 @@
+{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"File"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/file\/file"],"traits":[{"interfaceLanguage":"swift"}]}],"relationshipsSections":[{"identifiers":["doc:\/\/File\/documentation\/File\/FileSystem","doc:\/\/File\/s23CustomStringConvertibleP","doc:\/\/File\/SQ"],"kind":"relationships","title":"Conforms To","type":"conformsTo"}],"identifier":{"url":"doc:\/\/File\/documentation\/File\/File","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"File functionality in PLFile"}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"File"}],"title":"File","roleHeading":"Structure","role":"symbol","symbolKind":"struct","externalID":"s:4FileAAV","modules":[{"name":"File"}],"navigatorTitle":[{"kind":"identifier","text":"File"}]},"hierarchy":{"paths":[["doc:\/\/File\/documentation\/File"]]},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/File\/documentation\/File\/File\/init(store:)"]},{"title":"Instance Properties","identifiers":["doc:\/\/File\/documentation\/File\/File\/store"]},{"title":"Instance Methods","identifiers":["doc:\/\/File\/documentation\/File\/File\/append(_:)","doc:\/\/File\/documentation\/File\/File\/append(_:encoding:)","doc:\/\/File\/documentation\/File\/File\/open()","doc:\/\/File\/documentation\/File\/File\/read()","doc:\/\/File\/documentation\/File\/File\/write(_:)","doc:\/\/File\/documentation\/File\/File\/write(_:encoding:)"]},{"title":"Default Implementations","identifiers":["doc:\/\/File\/documentation\/File\/File\/Equatable-Implementations","doc:\/\/File\/documentation\/File\/File\/FileSystem-Implementations"],"generated":true}],"references":{"doc://File/documentation/File/File/append(_:)":{"role":"symbol","title":"append(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"append"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"append binary data in the file, exist contexts"}],"identifier":"doc:\/\/File\/documentation\/File\/File\/append(_:)","kind":"symbol","type":"topic","url":"\/documentation\/file\/file\/append(_:)"},"doc://File/documentation/File/File/open()":{"role":"symbol","title":"open()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"open"},{"kind":"text","text":"()"}],"abstract":[{"type":"text","text":"open file"}],"identifier":"doc:\/\/File\/documentation\/File\/File\/open()","kind":"symbol","type":"topic","url":"\/documentation\/file\/file\/open()"},"doc://File/documentation/File/FileSystem":{"role":"symbol","title":"FileSystem","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"FileSystem"}],"abstract":[{"type":"text","text":"Can use the functions of the file system as a key feature of PLFile."}],"identifier":"doc:\/\/File\/documentation\/File\/FileSystem","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"FileSystem"}],"url":"\/documentation\/file\/filesystem"},"doc://File/documentation/File/File/store":{"role":"symbol","title":"store","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Store","preciseIdentifier":"s:4File5StoreC"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"File","preciseIdentifier":"s:4FileAAV"},{"kind":"text","text":">"}],"abstract":[],"identifier":"doc:\/\/File\/documentation\/File\/File\/store","kind":"symbol","type":"topic","url":"\/documentation\/file\/file\/store"},"doc://File/documentation/File/File/write(_:)":{"role":"symbol","title":"write(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"write binary data in the file and replace current contexts"}],"identifier":"doc:\/\/File\/documentation\/File\/File\/write(_:)","kind":"symbol","type":"topic","url":"\/documentation\/file\/file\/write(_:)"},"doc://File/s23CustomStringConvertibleP":{"type":"unresolvable","title":"Swift.CustomStringConvertible","identifier":"doc:\/\/File\/s23CustomStringConvertibleP"},"doc://File/documentation/File/File/read()":{"role":"symbol","title":"read()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"() "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"}],"abstract":[{"type":"text","text":"read the contents binary data in the file"}],"identifier":"doc:\/\/File\/documentation\/File\/File\/read()","kind":"symbol","type":"topic","url":"\/documentation\/file\/file\/read()"},"doc://File/documentation/File/File/init(store:)":{"role":"symbol","title":"init(store:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"store"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Store","preciseIdentifier":"s:4File5StoreC"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"File","preciseIdentifier":"s:4FileAAV"},{"kind":"text","text":">)"}],"abstract":[],"identifier":"doc:\/\/File\/documentation\/File\/File\/init(store:)","kind":"symbol","type":"topic","url":"\/documentation\/file\/file\/init(store:)"},"doc://File/documentation/File":{"role":"collection","title":"File","abstract":[],"identifier":"doc:\/\/File\/documentation\/File","kind":"symbol","type":"topic","url":"\/documentation\/file"},"doc://File/documentation/File/File/Equatable-Implementations":{"role":"collectionGroup","title":"Equatable Implementations","abstract":[],"identifier":"doc:\/\/File\/documentation\/File\/File\/Equatable-Implementations","kind":"article","type":"topic","url":"\/documentation\/file\/file\/equatable-implementations"},"doc://File/documentation/File/File/write(_:encoding:)":{"role":"symbol","title":"write(_:encoding:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"encoding"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Encoding","preciseIdentifier":"s:SS10FoundationE8EncodingV"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"write new string into the file and replace current contexts."}],"identifier":"doc:\/\/File\/documentation\/File\/File\/write(_:encoding:)","kind":"symbol","type":"topic","url":"\/documentation\/file\/file\/write(_:encoding:)"},"doc://File/documentation/File/File/FileSystem-Implementations":{"role":"collectionGroup","title":"FileSystem Implementations","abstract":[],"identifier":"doc:\/\/File\/documentation\/File\/File\/FileSystem-Implementations","kind":"article","type":"topic","url":"\/documentation\/file\/file\/filesystem-implementations"},"doc://File/SQ":{"type":"unresolvable","title":"Swift.Equatable","identifier":"doc:\/\/File\/SQ"},"doc://File/documentation/File/File":{"role":"symbol","title":"File","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"File"}],"abstract":[{"type":"text","text":"File functionality in PLFile"}],"identifier":"doc:\/\/File\/documentation\/File\/File","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"File"}],"url":"\/documentation\/file\/file"},"doc://File/documentation/File/File/append(_:encoding:)":{"role":"symbol","title":"append(_:encoding:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"append"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"encoding"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Encoding","preciseIdentifier":"s:SS10FoundationE8EncodingV"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"append string into the file, exist contexts"}],"identifier":"doc:\/\/File\/documentation\/File\/File\/append(_:encoding:)","kind":"symbol","type":"topic","url":"\/documentation\/file\/file\/append(_:encoding:)"}}}

main/data/documentation/file/file/!=(_:_:).json

@@ -0,0 +1 @@
+{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"kind":"internalParam","text":"rhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/file\/file\/!=(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/File\/documentation\/File\/File\/!=(_:_:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"Equatable.!=(_:_:)"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"role":"symbol","title":"!=(_:_:)","roleHeading":"Operator","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"symbolKind":"op","externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:4FileAAV","extendedModule":"Swift","modules":[{"name":"File"}]},"hierarchy":{"paths":[["doc:\/\/File\/documentation\/File","doc:\/\/File\/documentation\/File\/File","doc:\/\/File\/documentation\/File\/File\/Equatable-Implementations"]]},"references":{"doc://File/documentation/File/File/!=(_:_:)":{"role":"symbol","title":"!=(_:_:)","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"abstract":[],"identifier":"doc:\/\/File\/documentation\/File\/File\/!=(_:_:)","kind":"symbol","type":"topic","url":"\/documentation\/file\/file\/!=(_:_:)"},"doc://File/documentation/File/File":{"role":"symbol","title":"File","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"File"}],"abstract":[{"type":"text","text":"File functionality in PLFile"}],"identifier":"doc:\/\/File\/documentation\/File\/File","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"File"}],"url":"\/documentation\/file\/file"},"doc://File/documentation/File":{"role":"collection","title":"File","abstract":[],"identifier":"doc:\/\/File\/documentation\/File","kind":"symbol","type":"topic","url":"\/documentation\/file"},"doc://File/documentation/File/File/Equatable-Implementations":{"role":"collectionGroup","title":"Equatable Implementations","abstract":[],"identifier":"doc:\/\/File\/documentation\/File\/File\/Equatable-Implementations","kind":"article","type":"topic","url":"\/documentation\/file\/file\/equatable-implementations"}}}