Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix casing for documentation root #5

Merged
merged 1 commit into from
Aug 1, 2024
Merged

Fix casing for documentation root #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/data/documentation/slipstream.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"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"}}}
{"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","abstract":[{"text":"Build static web pages with Swift and Tailwind CSS.","type":"text"}],"topicSections":[{"identifiers":["doc:\/\/Slipstream\/documentation\/Slipstream\/Fundamentals","doc:\/\/Slipstream\/documentation\/Slipstream\/TextInputAndOutput"],"anchor":"Views","title":"Views"},{"anchor":"Rendering-Views","title":"Rendering Views","identifiers":["doc:\/\/Slipstream\/documentation\/Slipstream\/renderHTML(_:)"]}],"variants":[{"paths":["\/documentation\/slipstream"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"content","content":[{"text":"Overview","level":2,"type":"heading","anchor":"Overview"},{"type":"paragraph","inlineContent":[{"identifier":"logo","type":"image"}]},{"inlineContent":[{"type":"text","text":"Slipstream is a declarative framework that allows you to write SwiftUI-like"},{"type":"text","text":" "},{"text":"code to generate HTML compatible with ","type":"text"},{"identifier":"https:\/\/tailwindcss.com\/docs\/installation","isActive":true,"type":"reference"},{"text":",","type":"text"},{"type":"text","text":" "},{"text":"a utility-first CSS framework.","type":"text"}],"type":"paragraph"},{"type":"paragraph","inlineContent":[{"text":"By using a SwiftUI-like domain-specific language (DSL), Slipstream provides a","type":"text"},{"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":"codeListing","syntax":"swift","code":["import Slipstream","","struct HelloWorld: View {"," var body: some View {"," Text(\"Hello, world!\")"," }","}","","print(try renderHTML(HelloWorld()))"]},{"text":"Key features","type":"heading","anchor":"Key-features","level":3},{"type":"unorderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"inlineContent":[{"text":"SwiftUI-like DSL","type":"text"}],"type":"strong"},{"text":": Write Swift code to define your web page’s structure","type":"text"},{"type":"text","text":" "},{"text":"and styling. The DSL is designed to be intuitive and expressive, making it","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"easy to create complex layouts with simple code."}]}]},{"content":[{"inlineContent":[{"type":"strong","inlineContent":[{"text":"Tailwind CSS Integration","type":"text"}]},{"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"},{"text":"library of utility classes for styling.","type":"text"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"inlineContent":[{"text":"Static Site Generation","type":"text"}],"type":"strong"},{"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":" "},{"type":"text","text":"to static site hosting platforms such as GitHub Pages."}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"strong","inlineContent":[{"text":"Modular and Composable","type":"text"}]},{"type":"text","text":": Build reusable components and compose them to"},{"type":"text","text":" "},{"type":"text","text":"create more complex UI elements."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"strong","inlineContent":[{"type":"text","text":"Flexible Rendering"}]},{"type":"text","text":": As a framework, Slipstream can be integrated into any"},{"text":" ","type":"text"},{"text":"type of static website, whether it’s a blog, portfolio, product landing page,","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"or your personal pet project (maybe even literally a webpage for your pet?)."}]}]}]}]}],"hierarchy":{"paths":[[]]},"metadata":{"symbolKind":"module","modules":[{"name":"Slipstream"}],"roleHeading":"Framework","externalID":"Slipstream","role":"collection","title":"Slipstream"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/Slipstream\/documentation\/Slipstream"},"sections":[],"references":{"doc://Slipstream/documentation/Slipstream/Fundamentals":{"abstract":[{"type":"text","text":"Define the visual elements of your website using a hierarchy of views."}],"title":"View fundamentals","identifier":"doc:\/\/Slipstream\/documentation\/Slipstream\/Fundamentals","type":"topic","url":"\/documentation\/slipstream\/fundamentals","kind":"article","role":"collectionGroup"},"doc://Slipstream/documentation/Slipstream":{"identifier":"doc:\/\/Slipstream\/documentation\/Slipstream","role":"collection","type":"topic","url":"\/documentation\/slipstream","abstract":[{"text":"Build static web pages with Swift and Tailwind CSS.","type":"text"}],"title":"Slipstream","kind":"symbol"},"doc://Slipstream/documentation/Slipstream/renderHTML(_:)":{"url":"\/documentation\/slipstream\/renderhtml(_:)","identifier":"doc:\/\/Slipstream\/documentation\/Slipstream\/renderHTML(_:)","title":"renderHTML(_:)","type":"topic","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"renderHTML","kind":"identifier"},{"kind":"text","text":"(any "},{"kind":"typeIdentifier","text":"View","preciseIdentifier":"s:10Slipstream4ViewP"},{"text":") ","kind":"text"},{"kind":"keyword","text":"throws"},{"text":" -> ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"Renders the given view as an HTML document and returns the HTML."}],"role":"symbol"},"https://tailwindcss.com/docs/installation":{"identifier":"https:\/\/tailwindcss.com\/docs\/installation","type":"link","titleInlineContent":[{"text":"Tailwind CSS","type":"text"}],"title":"Tailwind CSS","url":"https:\/\/tailwindcss.com\/docs\/installation"},"logo":{"identifier":"logo","type":"image","variants":[{"url":"\/images\/Slipstream\/logo.svg","traits":["1x","light"]}],"alt":"The Slipstream logo. The Swift bird logo is flying off the edge of the Tailwind CSS wind logo."},"doc://Slipstream/documentation/Slipstream/TextInputAndOutput":{"identifier":"doc:\/\/Slipstream\/documentation\/Slipstream\/TextInputAndOutput","abstract":[{"type":"text","text":"Display text."}],"title":"Text input and output","url":"\/documentation\/slipstream\/textinputandoutput","kind":"article","type":"topic","role":"collectionGroup"}}}
Loading