Introducing “Easy Docs”

Posted in: WordPress

Mar 07

Tags:

This one is targeted at a very niche audience — the people who have to write documentation for products. I came across the need for a documentation template awhile ago when I released my first two products (Shaken Grid and Shaken Tumble). I decided to create this WordPress theme to streamline the process and make the task of writing documentation a little less painful.

Features

View the video demo above or the live demo to get a feel for what the theme is capable of. I built the theme to fulfill my requirements, which were very basic; a page for documentation with a simple way to navigate between sections, and a basic page template for simple pages like a Changelog.

View more info and download

Discussion

  1. Donna Vitan Mar 8, 2011 at 11:21 am #

    Thanks for sharing. I haven’t had the need to create too many documentation but the demo shows a great and easy way to do so.

    Kinda want to document something now that I’ve seen this!

  2. Melvin Jose Mar 8, 2011 at 12:47 pm #

    Awesome freebie.
    Thanks loads

  3. Todd Smith-Salter Mar 8, 2011 at 1:05 pm #

    This is fantastic! There are so many uses for this theme that I can think of off the top of my head.

    Thank you so much for your contribution to our web design and dev community.

  4. Robert Picard Mar 8, 2011 at 2:10 pm #

    This could probably be used for a privacy policy / terms of service.

  5. Bert de Vries Mar 8, 2011 at 2:56 pm #

    Looks very nice! THX for sharing this.

  6. David Vielmetter Mar 8, 2011 at 11:03 pm #

    Superb! I love the simple yet functional design. Thank you so much.

  7. Andrew B Mar 9, 2011 at 2:08 am #

    Our congratulations! Excellent theme.

  8. Phong Nguyen Apr 4, 2011 at 2:13 pm #

    I love this theme so much. I actually am working on documenting several projects we have just completed. Is there a way to expand this to include “projects,” then have several sections under each project? I’m thinking each project can be a separate page and shown in the top menu? I would totally pay for something like that.

    Thanks so much.

    Phong

    • Sawyer Apr 4, 2011 at 7:23 pm #

      Glad you like the theme! There isn’t at the moment although I’ll see what I can do for a future update. I’m not currently available for extra work.

      The easiest thing may be to setup your WordPress installation to support Multisite…read more about that here: http://codex.wordpress.org/Create_A_Network

  9. Eric Jul 27, 2011 at 2:36 pm #

    I’m trying to go deeper than just 2 levels deep within each section. I’m finding that anything beyond 2 levels won’t display at all. Is this programmed in the code? How do I edit this?

    • Sawyer Jul 27, 2011 at 7:09 pm #

      Yeah, it’s restricted to just 2 levels at the moment. You’ll want to edit loop-sections.php and edit the $childLoop query.

      • Eric Jul 27, 2011 at 8:53 pm #

        If you’re talking about this line right here:

        $childLoop = new WP_Query(‘posts_per_page=-1&post_type=section&orderby=menu_order&post_parent=’.get_the_ID());

        What parameter am I supposed to modify?

        • Sawyer Jul 27, 2011 at 11:02 pm #

          Yeah, I’m not sure if there’s an easy way to do it or not. You may just need to create another query like that one for each level. What the query is doing is grabbing the post ID of the parent section and querying all of its children.

          • Eric Jul 28, 2011 at 4:40 pm #

            That worked…copying the childLoop, renaming it, and then nesting it directly after the div tags that contain the h3 tag.

Leave a Reply

Your email address will not be published. Required fields are marked *

*

You may use these HTML tags and attributes: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>