After a few weeks of work, I'm excited to finally release Formik's new documentation website as well as its new domain at https://formik.org.
Formik was one of the earliest users of Facebook's Docusaurus documentation framework. It worked great and, due to limited styling options, it helped ensure we stayed focused on the content and not on the looks.
That being said, Docusaurus v1 has its shortcomings. First, it is truly a static site generator. It spits out pure HTML. This is great for a lot of libraries and tools, but for something like Formik, which is a React package, the inability to run modern client-side JS became frustrating. Things like in-page playgrounds or editable code-blocks were not feasible.
When it came time to give the docs a much-needed refresh, I evaluated Gatsby and Docusaurus v2, but ultimately decided to go with Next.js. Thanks to new features like
getStaticProps, catch-all routes, and incremental static-site generation, the Formik docs now have solid foundation upon which we can innovate going forward.
The Formik docs are built with:
What follows in the rest of this post is a more detailed overview of Formik's documentation stack, some of the rationale behind it, and a few cool tidbits you might find interesting.
I chose Next.js over alternatives such as Gatsby and Docusaurus v2 for several reasons. The biggest factor in the decision is that I believe that documentation is part of the product. Since some of my forthcoming SaaS dashboard and marketing sites already use Next.js, staying within the Next.js universe meant all of the codebases would work the same way, even the open source ones. This reduces cognitive overhead and makes it easier to work across applications and share components.
Gatsby is a React-based static site generator with a rich plugin and theme ecosystem. Its key value proposition is a single data graph powered by GraphQL. With respect to documentation sites, Gatsby themes—groups of plugins, layouts, and components that child themes can then inherit— are extremely useful. Given the growing number of OSS projects we are working on, this was seriously compelling. However, I am fairly convinced that GraphQL is still wildly overkill for documentation and most static document-driven websites. And yes, I am fully aware that you don't technically need to use GraphQL with Gatsby, but it is definitely its happy path.
As of writing, Docusaurus v2.0 is still in alpha. The new version fixes a lot of issues with v1.0 by allowing for client-side React, plugins, and even custom themes.
The biggest issue for me with Docusaurus 2 was/is its base theme.
For many projects, Facebook's new static CSS framework for docs called Infima (which Docusaurus uses and is co-developed by the same team) is fine. However, there are few things about it that really bother me.
Mobile Navigation feels awkward
I consistently struggle to navigate every Docusaurus v2 website on mobile. I find the floating sub-navigation to be unintuitive compared to Docusaurus v1's sub-navbar. Here's a comparison video. v1 is on the left and v2 is on the right.
Infima CSS isn't easy to theme
While Infima CSS is a complete CSS framework, it has somewhat limited theming options. Keeping the new Formik docs looking visually congruent with our enterprise SaaS app's design system also seemed like it would be challenging since we would need to bend/extend Infima CSS significantly.
Lack of Community Themes
Another great addition to Docusaurus in v2 is custom theming and first-class theme component overriding (a.k.a "Swizzling"). If you've never heard of it before, component swizzling works similarly to Wordpress's template hierarchy for themes and plugins, but for React components. When you run
docusaurus swizzle <theme name> [component name] , Docusaurus copies that component from the specified theme out of
node_modules and into a local file in
src/theme/[component name] . You can then make all the changes you want to that file and Docusaurus will use the "Swizzled" version instead of the base one when it builds your site.
The big downside to Swizzling is the same one that forever afflicts Wordpress child themes—it can make upgrading much more complicated (especially when new features are added to the base theme). This problem is so prominent in fact, that the Docusaurus docs currently warn against Swizzling until v2 reaches the beta stage:
We would like to discourage swizzling of components until we've minimally reached a Beta stage. The components APIs have been changing rapidly and are likely to keep changing until we reach Beta. Stick with the default appearance for now if possible to save yourself some potential pain in future.
At this point, I spent a bit of time evaluating what it would take to write our own custom Docusaurus v2 theme for Formik, but ultimately decided against it because of the above warning. My rationale was that if I was going to go down that rabbit hole, I might as well just retain full control of the entire markdown processing pipeline with Next.js–and that's exactly what I did...
With a little bit of effort, Next.js can be great for documentation—with MDX being the secret sauce. However, getting it to feature-parity with Docusaurus will take considerable effort and is not for the faint of heart. That being said, I'm super happy with how the new docs work, how easy it is contribute to them, and the way the site looks.
Worth pointing out that Formik's new docs handle MDX slightly differently than most Next.js sites likely do. Instead of using the official
@next/mdx plugin, I shamelessly stole Brent Vatne's custom webpack loader from the Expo.io docs which automagically extracts front-matter and injects a wrapper Layout component export in every .mdx file.
By default, this loader injects the
LayoutDocs.tsx layout component as a wrapper, but additional layouts can be added whenever we need them. They can be specified on a per-page basis via
layout frontmatter key.
Instead of using a traditional CMS or MDX, this blog you're reading right now is actually powered by Notion and Next.js's Static Site Generation feature. We keep posts in a table in a Notion API with relevant metadata and then map Notion's undocumented API to custom React components in
./src/pages/blog/[...slug].tsx . The result is amazing and a fantastic writing experience. For a more detailed example of this setup and one that you can deploy immediately, go here: https://notion-blog.now.sh/
I've been a fan of Atomic CSS for many many years. Tailwind is the latest and perhaps greatest of all Atomic CSS frameworks. It's flexible, it's intuitive, it looks great, and nothing beats it perf-wise (cuz it's just CSS!). Thanks to Tailwind 1.4.x, we're able to purge all extraneous class with its new
purge feature too.
I accidentally discovered the new version of docsearch.js while working on the docs and it's even better than I could have ever imagined. It has a cool omnibar and even keeps track of recent searches and favorites.
Overall, I'm pretty happy with the new docs site. For the first time in a while, I'm excited to write docs again. There's still a decent amount of features still missing, but I'm very happy with the end-user experience and the developer experience that this stack provides. Next.js gives us a great foundation for building more app-like features into the docs site. The first of these will be a brand new interactive tutorial as well as a new searchable example and boilerplate directory. As always, if you're if you're interested helping out or diving deeper, the full source code of the new docs is available on GitHub.
So with that, go poke around, but be gentle. If you find any bugs, file an issue. With this new Notion-powered blog, I'll be posting a lot more often, so enter your email and slap that subscribe button in the footer to join the Formik mailing list.