Repository files navigation

Faust.js is a toolkit for building Next.js applications for headless WordPress sites. Faust.js provides tooling to reduce the pains of building a headless WordPress site (namely around data fetching, authentication, previews, and SSR/SSG) while offering a pleasant experience for both developers and publishers.

• Getting started with Next.js

• Node.js v16.0.0 or newer (v16.8.0 when using Next.js 13 and v18.17 when using Next.js 14).
• MacOS, Windows (including WSL), and Linux are supported.

Visithttps://faustjs.org/docs/ to view the full documentation.

Docs are MD indocs. Here are a couple things you should know!

1. Our Docs supportGithub Flavored Markdown (GFM).

2. Images should be stored along side the doc that uses them in animages/ folder.

3. Shared Images can be stored in a shared folder @docs/images

4. Callouts: These are similar to block quotes or an aside but for various warnings, info, pro times, etc.

5. Code Blocks:

   • Required

     1. Specify a language:```js or`const inlineCode = [1,2,3];{:js}`
        • Commands for a users terminal =bash
        • env files =ini
        • JavaScript =js
        • TypeScript =ts
        • GraphQL =gql
        • JSON =json
        • For a full list see:https://shiki.style/languages
     2. Addline numbers to any complex code.ini andbash don't need to show line numbers generally. ```js showLineNumbers
     3. Complete files should have afile names ```js title="pages/_app.js

   • Optional

     1. Lines can behighlighted in code blocks ```js {1,3-5}. There are a variety of advanced highlighting methods, see:https://rehype-pretty.pages.dev/#highlight-lines

     2. Lines may bediffed in a code block:

        console.log('hewwo')// [!code --]console.log('hello')// [!code ++]console.log('goodbye')

There are two key parts to Faust.js: the NPM packages and the WordPress plugin. To take full advantage of headless, you will need to install the plugin in addition to the npm packages.

You can download and install FaustWP from theWordPress Plugin Directory, or by using the zip linked below.

📥 Download Latest Version

To chat with other Faust.js users and the headless community as a whole, you can join theWP Engine Developers Discord.

Additionally, if you have questions or ideas, please share them onGitHub Discussions.

There are many ways tocontribute to this project.

• Discuss open issues to help define the future of the project.
• Submit bugs and help us verify fixes as they are checked in.
• Review and discuss thesource code changes.
• Contribute bug fixes

All external contributors to WP Engine products must have a signed Contributor License Agreement (CLA) in place before the contribution may be accepted into any WP Engine codebase.

1. Submit your name and email
2. 📝 Sign the CLA emailed to you
3. 📥 Receive copy of signed CLA

❤️ Thank you for helping us fulfill our legal obligations in order to continue empowering builders through headless WordPress.