Skip to content

Commit

Permalink
Update documentation root. (#4)
Browse files Browse the repository at this point in the history
  • Loading branch information
jverkoey authored Aug 1, 2024
1 parent 96738b6 commit b503fb7
Show file tree
Hide file tree
Showing 29 changed files with 29 additions and 29 deletions.
2 changes: 1 addition & 1 deletion docs/data/documentation/slipstream.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"kind":"symbol","metadata":{"modules":[{"name":"Slipstream"}],"role":"collection","title":"Slipstream","externalID":"Slipstream","symbolKind":"module","roleHeading":"Framework"},"topicSections":[{"title":"Views","identifiers":["doc:\/\/Slipstream\/documentation\/Slipstream\/Fundamentals","doc:\/\/Slipstream\/documentation\/Slipstream\/TextInputAndOutput"],"anchor":"Views"},{"title":"Rendering Views","anchor":"Rendering-Views","identifiers":["doc:\/\/Slipstream\/documentation\/Slipstream\/renderHTML(_:)"]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"url":"doc:\/\/Slipstream\/documentation\/Slipstream","interfaceLanguage":"swift"},"primaryContentSections":[{"content":[{"anchor":"Overview","level":2,"text":"Overview","type":"heading"},{"type":"paragraph","inlineContent":[{"identifier":"logo","type":"image"}]},{"type":"paragraph","inlineContent":[{"text":"Slipstream is a declarative framework that allows you to write SwiftUI-like","type":"text"},{"type":"text","text":" "},{"text":"code to generate HTML compatible with ","type":"text"},{"type":"reference","identifier":"https:\/\/tailwindcss.com\/docs\/installation","isActive":true},{"type":"text","text":","},{"text":" ","type":"text"},{"text":"a utility-first CSS framework.","type":"text"}]},{"inlineContent":[{"type":"text","text":"By using a SwiftUI-like domain-specific language (DSL), Slipstream provides a"},{"type":"text","text":" "},{"type":"text","text":"familiar syntax for Swift developers, making it easy to create and style web"},{"type":"text","text":" "},{"text":"components without leaving the Swift ecosystem.","type":"text"}],"type":"paragraph"},{"type":"codeListing","syntax":"swift","code":["import Slipstream","","struct HelloWorld: View {"," var body: some View {"," Text(\"Hello, world!\")"," }","}","","print(try renderHTML(HelloWorld()))"]},{"text":"Key features","anchor":"Key-features","type":"heading","level":3},{"items":[{"content":[{"type":"paragraph","inlineContent":[{"inlineContent":[{"type":"text","text":"SwiftUI-like DSL"}],"type":"strong"},{"type":"text","text":": Write Swift code to define your web page’s structure"},{"text":" ","type":"text"},{"type":"text","text":"and styling. The DSL is designed to be intuitive and expressive, making it"},{"text":" ","type":"text"},{"type":"text","text":"easy to create complex layouts with simple code."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"strong","inlineContent":[{"type":"text","text":"Tailwind CSS Integration"}]},{"type":"text","text":": Slipstream outputs HTML that is fully"},{"type":"text","text":" "},{"type":"text","text":"compatible with Tailwind CSS, allowing you to leverage Tailwind’s extensive"},{"text":" ","type":"text"},{"text":"library of utility classes for styling.","type":"text"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"strong","inlineContent":[{"text":"Static Site Generation","type":"text"}]},{"type":"text","text":": Ideal for static web pages, Slipstream generates"},{"text":" ","type":"text"},{"type":"text","text":"static HTML files, which can be easily hosted on any web server or deployed"},{"type":"text","text":" "},{"text":"to static site hosting platforms such as GitHub Pages.","type":"text"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"strong","inlineContent":[{"type":"text","text":"Modular and Composable"}]},{"type":"text","text":": Build reusable components and compose them to"},{"text":" ","type":"text"},{"type":"text","text":"create more complex UI elements."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"inlineContent":[{"type":"text","text":"Flexible Rendering"}],"type":"strong"},{"text":": As a framework, Slipstream can be integrated into any","type":"text"},{"text":" ","type":"text"},{"text":"type of static website, whether it’s a blog, portfolio, product landing page,","type":"text"},{"text":" ","type":"text"},{"text":"or your personal pet project (maybe even literally a webpage for your pet?).","type":"text"}]}]}],"type":"unorderedList"}],"kind":"content"}],"sections":[],"abstract":[{"text":"Build static web pages with Swift and Tailwind CSS.","type":"text"}],"variants":[{"paths":["\/documentation\/slipstream"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[[]]},"references":{"doc://Slipstream/documentation/Slipstream/TextInputAndOutput":{"kind":"article","abstract":[{"text":"Display text.","type":"text"}],"title":"Text input and output","identifier":"doc:\/\/Slipstream\/documentation\/Slipstream\/TextInputAndOutput","type":"topic","url":"\/documentation\/slipstream\/textinputandoutput","role":"collectionGroup"},"doc://Slipstream/documentation/Slipstream/Fundamentals":{"identifier":"doc:\/\/Slipstream\/documentation\/Slipstream\/Fundamentals","url":"\/documentation\/slipstream\/fundamentals","type":"topic","role":"collectionGroup","abstract":[{"text":"Define the visual elements of your website using a hierarchy of views.","type":"text"}],"title":"View fundamentals","kind":"article"},"logo":{"identifier":"logo","type":"image","alt":"The Slipstream logo. The Swift bird logo is flying off the edge of the Tailwind CSS wind logo.","variants":[{"traits":["1x","light"],"url":"\/images\/Slipstream\/logo.svg"}]},"doc://Slipstream/documentation/Slipstream":{"url":"\/documentation\/slipstream","kind":"symbol","abstract":[{"text":"Build static web pages with Swift and Tailwind CSS.","type":"text"}],"title":"Slipstream","type":"topic","identifier":"doc:\/\/Slipstream\/documentation\/Slipstream","role":"collection"},"https://tailwindcss.com/docs/installation":{"identifier":"https:\/\/tailwindcss.com\/docs\/installation","type":"link","title":"Tailwind CSS","url":"https:\/\/tailwindcss.com\/docs\/installation","titleInlineContent":[{"text":"Tailwind CSS","type":"text"}]},"doc://Slipstream/documentation/Slipstream/renderHTML(_:)":{"kind":"symbol","abstract":[{"text":"Renders the given view as an HTML document and returns the HTML.","type":"text"}],"title":"renderHTML(_:)","identifier":"doc:\/\/Slipstream\/documentation\/Slipstream\/renderHTML(_:)","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"renderHTML"},{"text":"(any ","kind":"text"},{"preciseIdentifier":"s:10Slipstream4ViewP","text":"View","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"url":"\/documentation\/slipstream\/renderhtml(_:)","role":"symbol"}}}
{"abstract":[{"type":"text","text":"Build static web pages with Swift and Tailwind CSS."}],"primaryContentSections":[{"kind":"content","content":[{"level":2,"anchor":"Overview","type":"heading","text":"Overview"},{"type":"paragraph","inlineContent":[{"identifier":"logo","type":"image"}]},{"inlineContent":[{"text":"Slipstream is a declarative framework that allows you to write SwiftUI-like","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"code to generate HTML compatible with "},{"isActive":true,"type":"reference","identifier":"https:\/\/tailwindcss.com\/docs\/installation"},{"type":"text","text":","},{"type":"text","text":" "},{"text":"a utility-first CSS framework.","type":"text"}],"type":"paragraph"},{"type":"paragraph","inlineContent":[{"type":"text","text":"By using a SwiftUI-like domain-specific language (DSL), Slipstream provides a"},{"type":"text","text":" "},{"text":"familiar syntax for Swift developers, making it easy to create and style web","type":"text"},{"type":"text","text":" "},{"type":"text","text":"components without leaving the Swift ecosystem."}]},{"syntax":"swift","code":["import Slipstream","","struct HelloWorld: View {"," var body: some View {"," Text(\"Hello, world!\")"," }","}","","print(try renderHTML(HelloWorld()))"],"type":"codeListing"},{"type":"heading","text":"Key features","anchor":"Key-features","level":3},{"items":[{"content":[{"inlineContent":[{"inlineContent":[{"type":"text","text":"SwiftUI-like DSL"}],"type":"strong"},{"type":"text","text":": Write Swift code to define your web page’s structure"},{"text":" ","type":"text"},{"text":"and styling. The DSL is designed to be intuitive and expressive, making it","type":"text"},{"type":"text","text":" "},{"type":"text","text":"easy to create complex layouts with simple code."}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"inlineContent":[{"type":"text","text":"Tailwind CSS Integration"}],"type":"strong"},{"text":": Slipstream outputs HTML that is fully","type":"text"},{"type":"text","text":" "},{"type":"text","text":"compatible with Tailwind CSS, allowing you to leverage Tailwind’s extensive"},{"text":" ","type":"text"},{"type":"text","text":"library of utility classes for styling."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"strong","inlineContent":[{"type":"text","text":"Static Site Generation"}]},{"text":": Ideal for static web pages, Slipstream generates","type":"text"},{"text":" ","type":"text"},{"text":"static HTML files, which can be easily hosted on any web server or deployed","type":"text"},{"text":" ","type":"text"},{"text":"to static site hosting platforms such as GitHub Pages.","type":"text"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"inlineContent":[{"text":"Modular and Composable","type":"text"}],"type":"strong"},{"type":"text","text":": Build reusable components and compose them to"},{"type":"text","text":" "},{"text":"create more complex UI elements.","type":"text"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"strong","inlineContent":[{"type":"text","text":"Flexible Rendering"}]},{"text":": As a framework, Slipstream can be integrated into any","type":"text"},{"type":"text","text":" "},{"type":"text","text":"type of static website, whether it’s a blog, portfolio, product landing page,"},{"text":" ","type":"text"},{"text":"or your personal pet project (maybe even literally a webpage for your pet?).","type":"text"}]}]}],"type":"unorderedList"}]}],"sections":[],"variants":[{"paths":["\/documentation\/slipstream"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","identifier":{"url":"doc:\/\/Slipstream\/documentation\/Slipstream","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"roleHeading":"Framework","modules":[{"name":"Slipstream"}],"externalID":"Slipstream","role":"collection","symbolKind":"module","title":"Slipstream"},"topicSections":[{"anchor":"Views","title":"Views","identifiers":["doc:\/\/Slipstream\/documentation\/Slipstream\/Fundamentals","doc:\/\/Slipstream\/documentation\/Slipstream\/TextInputAndOutput"]},{"title":"Rendering Views","identifiers":["doc:\/\/Slipstream\/documentation\/Slipstream\/renderHTML(_:)"],"anchor":"Rendering-Views"}],"hierarchy":{"paths":[[]]},"references":{"https://tailwindcss.com/docs/installation":{"titleInlineContent":[{"text":"Tailwind CSS","type":"text"}],"url":"https:\/\/tailwindcss.com\/docs\/installation","identifier":"https:\/\/tailwindcss.com\/docs\/installation","title":"Tailwind CSS","type":"link"},"doc://Slipstream/documentation/Slipstream/Fundamentals":{"kind":"article","type":"topic","title":"View fundamentals","identifier":"doc:\/\/Slipstream\/documentation\/Slipstream\/Fundamentals","abstract":[{"text":"Define the visual elements of your website using a hierarchy of views.","type":"text"}],"url":"\/documentation\/slipstream\/fundamentals","role":"collectionGroup"},"doc://Slipstream/documentation/Slipstream/renderHTML(_:)":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"renderHTML","kind":"identifier"},{"text":"(any ","kind":"text"},{"text":"View","kind":"typeIdentifier","preciseIdentifier":"s:10Slipstream4ViewP"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"},{"kind":"text","text":" -> "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"url":"\/documentation\/slipstream\/renderhtml(_:)","kind":"symbol","identifier":"doc:\/\/Slipstream\/documentation\/Slipstream\/renderHTML(_:)","abstract":[{"text":"Renders the given view as an HTML document and returns the HTML.","type":"text"}],"type":"topic","role":"symbol","title":"renderHTML(_:)"},"doc://Slipstream/documentation/Slipstream":{"title":"Slipstream","type":"topic","kind":"symbol","abstract":[{"text":"Build static web pages with Swift and Tailwind CSS.","type":"text"}],"role":"collection","identifier":"doc:\/\/Slipstream\/documentation\/Slipstream","url":"\/documentation\/slipstream"},"doc://Slipstream/documentation/Slipstream/TextInputAndOutput":{"role":"collectionGroup","title":"Text input and output","kind":"article","type":"topic","url":"\/documentation\/slipstream\/textinputandoutput","abstract":[{"text":"Display text.","type":"text"}],"identifier":"doc:\/\/Slipstream\/documentation\/Slipstream\/TextInputAndOutput"},"logo":{"alt":"The Slipstream logo. The Swift bird logo is flying off the edge of the Tailwind CSS wind logo.","identifier":"logo","variants":[{"url":"\/images\/Slipstream\/logo.svg","traits":["1x","light"]}],"type":"image"}}}
Loading

0 comments on commit b503fb7

Please sign in to comment.