+44 0330 223 3428
Call Us
+44 0330 223 3428

WPTavern: WPThemeDoc: A Single-File HTML Template for Documenting WordPress Themes

WPTavern: WPThemeDoc: A Single-File HTML Template for Documenting WordPress Themes
photo credit: Lia Leslie

ThemeBeans founder Rich Tabor has open sourced WPThemeDoc, the template he uses for documenting his commercial WordPress themes. Tabor is also the creator of Merlin WP, a theme onboarding wizard that makes setup effortless for users. After applying his aesthetic talents to the documentation aspect of his business, he decided to package up his efforts and release WPThemeDoc on GitHub to benefit other theme developers.

WPThemeDoc is neatly organized and easy to navigate. It can be used without any design modifications or as a starting point for your own branded documentation design. Check out the live demo documenting Tabor’s York Pro theme.

The template is a single HTML file that is easy to extend by adding or removing sections. It includes a set of “find and replace” variables that developers can use to quickly customize the document’s information for their own themes. The template itself requires very little documentation, as it uses nothing more than simple HTML and CSS.

For many theme developers documentation is a chore – it’s not the fun part of creating themes. WPThemeDoc makes documentation as simple as filling in the blanks. It is licensed under the GPL v2.0 or later and feedback and contributions are welcome on GitHub.



Source: WordPress

Related Post
WPTavern: WordPress 4.9 Will Support Shortcodes and Embedded Media in the Text Widget

WPTavern: WordPress 4.9 Will Support Shortcodes and Embedded Media in the Text Widget WordPress 4.8 brought TinyMCE to the core Text widget, along with brand new Image, Video, and Audio media widgets. The upcoming 4.9 release builds on this progress and will introduce some long-awaited improvements to Text widget. Users will finally be able to […]

Read more
WPTavern: WPWeekly Episode 292 – Recap of WooConf and CaboPress

WPTavern: WPWeekly Episode 292 – Recap of WooConf and CaboPress In this episode, John James Jacoby and I are joined by Cody Landefeld, co-founder of Mode Effect. Landefeld described his experience attending WooConf as we reviewed highlights from the State of the Woo. We also discussed WooCommerce retiring its Canvas theme in favor of Storefront. Jacoby […]

Read more
WPTavern: Goodnight Firebug

WPTavern: Goodnight Firebug Twitter is lighting up with sentimental Firebug remembrances today after Mozilla announced it will reach end-of-life in the Firefox browser next month. Firebug was the first browser-based tool that allowed developers to easily inspect HTML and debug JS. It was discontinued as a separate add-on and merged into Firefox DevTools in 2016 […]

Read more