The PizazzWP Codex Documentation System (Codex for short), is a means to easily create multi-step documentation and was inspired by ScreenSteps and Flatdocs. It provides specific sections for your description, examples, media and code.
This enables you to easily make guides, manuals, tutorials and any other type of documentation with a consistent and user-friendly layout.
Each document is made up of:
- Title
- Featured image
- Document detail (i.e. this bit)
- Zero or more steps made up of one to three sections for step detail, image or video, and code.
This page, is of course, created and displayed using Codex
Document steps
A document is made up of a series of steps.
These can have a section for the description, a section for an image or video and/or a section to display code.
All sections are optional
// The Query
$query1 = new WP_Query( $args );
// The Loop
while ( $query1->have_posts() ) {
$query1->the_post();
echo '<li>' . get_the_title() . '</li>';
}
/* Restore original Post Data
* NB: Because we are using new WP_Query we aren't stomping on the
* original $wp_query and it does not need to be reset with
* wp_reset_query(). We just need to set the post data back up with
* wp_reset_postdata().
*/
wp_reset_postdata();
Another step
You can have as many steps as you like.
This step has a video in the media section. This video has to live on your server. If you want to do YouTube videos, you can simply paste their embed code in the description section.
Codex live
The best place to see a live usage of Codex is on the Architect documentation pages.