You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This PR does a bunch of cleanup to the blog posts — issues that were
largely introduced during the v3 to v4 migration, including:
- Adding more consistent media styles for video, image, and iframe
styles
- Add `<ol>` styles
- Moving the first video/image to the top of the blog posts (where
appropriate)
- Making heading casing more consistent
- Fixing various formatting issues
I'd learned a ton from blog posts, books, and screencasts, but I still craved
37
-
the chance to dig into a real-world codebase crafted by people I trust and
38
-
study how they put all that knowledge together to build a production-ready
39
-
application.
26
+
When I was early in my programming career, I loved following <Linkhref="https://thoughtbot.com/">thoughtbot</Link>. They were always writing interesting programming articles, producing fantastic screencasts, and publishing incredible books. I could tell they really cared about their craft and it inspired the hell out of me.
40
27
41
-
That experience was transformative for me, and so for a long time I've wanted
42
-
to give people something like it to learn how real websites are built with
43
-
Tailwind CSS.
28
+
But when they launched <Linkhref="https://thoughtbot.com/upcase">Upcase</Link>, the thing I was most excited about wasn't the courses or weekly videos. What I was most excited about was the source code for Upcase itself — the _actual-in-production_ Rails codebase that they gave you access to when you subscribed.
44
29
45
-
How a layout is broken down into components, what sort of APIs those
46
-
components expose, how the config has been customized — all of the interesting
47
-
decisions that you can't see when you just click _view source_ in the browser.
30
+
I'd learned a ton from blog posts, books, and screencasts, but I still craved the chance to dig into a real-world codebase crafted by people I trust and study how they put all that knowledge together to build a production-ready application.
48
31
49
-
So today we're releasing our first batch of official Tailwind CSS{""}
32
+
That experience was transformative for me, and so for a long time I've wanted to give people something like it to learn how real websites are built with Tailwind CSS.
50
33
51
-
<Linkhref="https://tailwindui.com/templates">website templates</Link> — beautiful designs engineered into
52
-
production-quality codebases, powered by Tailwind CSS and Next.js.
34
+
How a layout is broken down into components, what sort of APIs those components expose, how the config has been customized — all of the interesting decisions that you can't see when you just click _view source_ in the browser.
So today we're releasing our first batch of official Tailwind CSS <Linkhref="https://tailwindui.com/templates">website templates</Link> — beautiful designs engineered into production-quality codebases, powered by Tailwind CSS and Next.js.
55
37
56
-
We started designing these way back in March and I'm really excited to get
57
-
these first five out the door so you can check them out and start playing with
58
-
them:
38
+
We started designing these way back in March and I'm really excited to get these first five out the door so you can check them out and start playing with them:
59
39
60
40
- <Linkhref="https://syntax.tailwindui.com/">Syntax</Link> — a documentation site template powered by Stripe's new <Linkhref="https://markdoc.io/">
61
41
Markdoc
@@ -69,80 +49,43 @@ them:
69
49
- <Linkhref="https://transmit.tailwindui.com/">Transmit</Link> — an awesome podcasting template with a custom
70
50
persistent audio player that you can wire up to your own RSS feed in no time.
71
51
72
-
We've put a ton of time and attention into both the design and the code, and
73
-
everything is structured exactly the way we'd do it in a real production
74
-
project. They're the perfect starting point when you don't want to start from a
75
-
blank canvas, and the best way to learn how experts build modern websites with
76
-
Tailwind CSS.
52
+
We've put a ton of time and attention into both the design and the code, and everything is structured exactly the way we'd do it in a real production project. They're the perfect starting point when you don't want to start from a blank canvas, and the best way to learn how experts build modern websites with Tailwind CSS.
77
53
78
54
<Imagealt="Code Structure"src={codeStructure} />
79
55
80
-
Each template can be purchased on its own for **$99**, or you can get all of
81
-
them with <Linkhref="https://tailwindui.com/all-access">all-access</Link> —
82
-
the new _get-everything-we-ever-add-forever_ package we're launching today.
56
+
Each template can be purchased on its own for **$99**, or you can get all of them with <Linkhref="https://tailwindui.com/all-access">all-access</Link> — the new _get-everything-we-ever-add-forever_ package we're launching today.
83
57
84
58
---
85
59
86
60
## Going all in on all-access
87
61
88
-
When we started working on templates, one of the things I was really sure about
89
-
is that I wanted it to be easy to get access to _all_ of them.
62
+
When we started working on templates, one of the things I was really sure about is that I wanted it to be easy to get access to _all_ of them.
90
63
91
64
This was important to me for two reasons:
92
65
93
-
1.**I want people to think of our templates more like educational resources
94
-
than traditional website themes**. Every template we build has its own
95
-
unique learning moments, and I don't want people to have to be selective
96
-
about what they get to learn from.
97
-
98
-
2.**I don't want to worry about ROI on a per-template basis**. Nothing would
99
-
suck the fun out of designing and building templates like having to make
100
-
sure each one had mass appeal. I want us to have the freedom to make niche,
101
-
interesting stuff with cool ideas to study, not just templates that can sell
102
-
enough copies on their own to justify the work we put into them.
103
-
104
-
When I was a kid I went to this{""}
105
-
106
-
<Linkhref="https://en.concerts-metal.com/concert_-_Hellfest_2008-3308.html">music festival</Link> in France where
107
-
almost a hundred bands performed. There were a couple of bands on the bill I absolutely _loved_, knew every song, and
108
-
would buy a ticket to see any day of the week.
66
+
1.**I want people to think of our templates more like educational resources than traditional website themes**. Every template we build has its own unique learning moments, and I don't want people to have to be selective about what they get to learn from.
67
+
2.**I don't want to worry about ROI on a per-template basis**. Nothing would suck the fun out of designing and building templates like having to make sure each one had mass appeal. I want us to have the freedom to make niche, interesting stuff with cool ideas to study, not just templates that can sell enough copies on their own to justify the work we put into them.
109
68
110
-
Most of them though were bands I really _liked_, but wouldn't have made the 90
111
-
minute drive to make it out to a show. But putting all of them on a bill
112
-
together got me to buy a plane ticket to Paris, and have one of the best
113
-
experiences of my life.
69
+
When I was a kid I went to this <Linkhref="https://en.concerts-metal.com/concert_-_Hellfest_2008-3308.html">music festival</Link> in France where almost a hundred bands performed. There were a couple of bands on the bill I absolutely _loved_, knew every song, and would buy a ticket to see any day of the week.
114
70
115
-
I want Tailwind UI to feel like a music festival, where you can wander from
116
-
stage to stage, enjoy a song or two from a band you've never heard of, and once
117
-
in a while be blown away by a performance you would have never otherwise
118
-
bothered to check out.
71
+
Most of them though were bands I really _liked_, but wouldn't have made the 90 minute drive to make it out to a show. But putting all of them on a bill together got me to buy a plane ticket to Paris, and have one of the best experiences of my life.
119
72
120
-
So we're launching a new{""}
73
+
I want Tailwind UI to feel like a music festival, where you can wander from stage to stage, enjoy a song or two from a band you've never heard of, and once in a while be blown away by a performance you would have never otherwise bothered to check out.
121
74
122
-
<Linkhref="https://tailwindui.com/all-access">all-access package</Link> for Tailwind UI that includes access to every
123
-
template and component package that exists today and any new content we add in the future.
75
+
So we're launching a new <Linkhref="https://tailwindui.com/all-access">all-access package</Link> for Tailwind UI that includes access to every template and component package that exists today and any new content we add in the future.
It's a one-time purchase of **$299**. No subscription, no upgrade costs — if we
128
-
add something new to Tailwind UI, it's yours, forever.
79
+
It's a one-time purchase of **$299**. No subscription, no upgrade costs — if we add something new to Tailwind UI, it's yours, forever.
129
80
130
-
And if you already own everything in Tailwind UI, **we've upgraded you to
131
-
all-access for free**.
81
+
And if you already own everything in Tailwind UI, **we've upgraded you to all-access for free**.
132
82
133
83
---
134
84
135
-
So there you have it — that's everything we've been working on for the last few
136
-
months!
85
+
So there you have it — that's everything we've been working on for the last few months!
137
86
138
-
We've got a bunch of new templates in the works already, and we're actively
139
-
working on extracting a lot of the component ideas from these templates into
140
-
new examples to include in the Marketing, Application UI, and Ecommerce
141
-
component categories.
87
+
We've got a bunch of new templates in the works already, and we're actively working on extracting a lot of the component ideas from these templates into new examples to include in the Marketing, Application UI, and Ecommerce component categories.
142
88
143
-
That's one of my favorite things about working on these site templates —
144
-
building real-world stuff with Tailwind is the best way for us to come up with
145
-
new component ideas, and to find ways to improve both Tailwind CSS and Headless
146
-
UI too.
89
+
That's one of my favorite things about working on these site templates — building real-world stuff with Tailwind is the best way for us to come up with new component ideas, and to find ways to improve both Tailwind CSS and Headless UI too.
147
90
148
91
Look forward to lots of new Tailwind UI stuff in the coming months!
Copy file name to clipboardExpand all lines: src/blog/2022-12-15-protocol-api-documentation-template/index.mdx
+7-63Lines changed: 7 additions & 63 deletions
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
1
import { adamwathan } from"@/app/blog/authors";
2
-
importImagefrom"next/image";
3
2
importLinkfrom"next/link";
4
3
import { Example } from"@/components/example.tsx";
5
4
import { Figure } from"@/components/figure";
5
+
import { Image, Video } from"@/components/media";
6
6
7
7
importhomefrom"./home.png";
8
8
importdocumentationfrom"./documentation.png";
@@ -23,12 +23,12 @@ export const meta = {
23
23
),
24
24
};
25
25
26
-
It's been months in the making but I'm excited to finally release our next website template — <Linkhref="https://tailwindui.com/templates/protocol">Protocol</Link>, a beautiful starter kit for building amazing API reference websites.
<Imagealt="Learn about the Protocol template"src={home} />
30
28
</Link>
31
29
30
+
It's been months in the making but I'm excited to finally release our next website template — <Linkhref="https://tailwindui.com/templates/protocol">Protocol</Link>, a beautiful starter kit for building amazing API reference websites.
31
+
32
32
Powered by Next.js and MDX and styled with Tailwind CSS, it's built exactly the way we'd build our own API reference documentation.
33
33
34
34
Play with the <Linkhref="https://protocol.tailwindui.com/">live demo</Link> or <Linkhref="https://tailwindui.com/templates/protocol">download the source</Link> if you've got a Tailwind UI all-access license — it's a free update of course for all-access customers.
@@ -39,57 +39,15 @@ As usual we had a lot of fun getting carried away with the design, and putting t
39
39
40
40
We've got sticky code blocks that stay in view as you scroll through the request and response details for that endpoint:
There's also this beautiful hover effect on the homepage cards — it follows your mouse cursor with this gradient glow that uncovers a subtle background pattern:
My favorite detail though has to be the sidebar navigation, which tracks the visible page content but using a sort of "minimap" strategy, where _all_ visible page sections are highlighted:
Watching this animate as you scroll through the page is really a sight to behold — props to <Linkhref="https://www.framer.com/motion/">Framer Motion</Link> for doing the heavy lifting here as usual. Even if I absolutely hated React I'm pretty sure I'd still use it just to use this library, it's really that good.
95
53
@@ -228,21 +186,7 @@ We love Algolia for documentation search, and we use it for the Tailwind CSS web
228
186
229
187
We've wired it up for Protocol as well, but this time using Algolia's headless <Linkhref="https://www.algolia.com/doc/ui-libraries/autocomplete/introduction/what-is-autocomplete/">autocomplete library</Link> so we had total control of the search UI:
The nice thing about this approach is we can use regular old utility classes to style everything instead of writing custom CSS to style an already-styled widget, which just feels a lot more _right_ in a Tailwind CSS project.
@@ -36,11 +36,9 @@ Over the last four months we've probably done more work on Tailwind UI than we e
36
36
37
37
Just a few days ago we released [Commit](https://tailwindui.com/templates/commit), a brand new changelog template we designed for Tailwind UI — built of course with Tailwind CSS and Next.js.
Public changelogs have become a really popular way to keep people in the loop about what you've been working on, and to stay accountable and build your shipping muscles. They aren't a new concept by any means of course, but I don't think it was until [Linear](https://linear.app/changelog) started publishing to their changelog site that others got excited about using them almost as an alternative to a company blog.
0 commit comments