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.

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

Adds worpress section #127

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
35 changes: 35 additions & 0 deletions wordpress.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Table of Contents

1. [Development Environment](#development-environment)
2. [Content Configuration](#content-configuration)
3. [PK Components](#pk-components)
4. [Plugins](#plugins)

# Development Environment

The P'unk Wordpress Boilerplate uses [Timber](https://timber.github.io/docs/), which is a plugin that allows us to access data in a simpler way and use Twig template files for markup.

We use Composer to install plugins locally and include ACF and Timber in the boilerplate by default. Any necessary project level plugins should be installed via Composer rather than installing through the Wordpress admin UI, though some paid plugins may require using the admin UI.

We use the Wordpress development tool, [Local](https://localwp.com/), for local development and WP Engine for hosting, which work together for smooth deployments and content syncing.

# Content Configuration

## ACF Flexible Content
We use ACF Flexible Content fields to create areas of components that editors can use to build out page layouts.

Components within the Flexible Content area should be created as ACF groups first, then cloned in the Flexible Content area so they can be reused as needed througout the site.

## Custom Posts, Single and Archive Pages
When creating custom post types that require a single and archive page, we use the Wordpress built-in archive page with a custom Twig template. If the archive page includes customizable page settings or additional components, those can be added through a custom options page under the custom post type.

## Navigation Menus
We use built-in wordpress menus for main navigation menus.

# PK Components
- Video

# Plugins
- Default Editor
- [Custom Twitter Feeds](https://smashballoon.com/custom-twitter-feeds/demo/setup/)
- [Gravity Forms](https://www.gravityforms.com/)