Skip To Main Content

Powered by Faust

By Joe Fusco on

You may have noticed things look a tad different around here these days – that is because the Faust.js team has completed migrating the previous version of the project’s documentation to a headless WordPress stack! 🎉

Previously, the project was hosted with Docusaurus – an open source project for building, deploying, and maintaining websites with markdown. It does a lot of things really well, however Faust.js empowers both developers and publishers with building headless WordPress sites, so it felt natural to have Faust.js’ documentation be supported by the framework itself, and hosted on WP Engine’s Atlas platform.

The Blueprint

The following WordPress plugins were leveraged to make this happen.

Menus

All of the menus on this site are now utilizing WordPress menu locations.

Menu Locations registered within the Faust.js WordPress plugin settings, including Primary, Secondary, Docs Sidebar, Footer 1, Footer 2, Footer 3, and Footer 4.
Menu Locations registered within the Faust.js WordPress plugin settings.

Content Structure

This latest iteration of the site adopts the Divio Documentation framework, structuring content into 4 distinct types.

A chart showing 4 quadrants. tutorials, how-to guides, reference, and explanation.

Four custom post types were registered for each of these types:

  • Tutorials
  • How-To Guides
  • Reference
  • Explanation

These can be seen in the sidebar for each of those custom post types.

Sidebar menu for Faust.js documentation showing the various custom post types

Although the repository for the current site design is not public, the team plans on providing a more detailed case study on how this new site was built in the future.

Additional Updates ✨

The team has been working on getting additional WordPress core blocks included within the @faustwp/blocks package.

As always, feel free to test out Faust.js nightly releases by using the `canary` tag.

Category:
Uncategorized
Tags:
Update