htmlpress

Convert static HTML/CSS into dynamic Wordpress themes and templates

Usage

  Usage: htmlpress [options] [command]
  
  Commands:
    help     Display help
    version  Display version
  
  Options:
    -4, --404                 get 404 page (enabled by default)
    -c, --clean               strip processed data attributes when possible (enabled by default)
    -d, --debug               show debugging info (disabled by default)
    -h, --help                Output usage information
    -m, --modules <list>      modules to use (defaults to ["core","wordpress","acf"])
    -o, --output [value]      directory to save theme to (defaults to "./")
    -p, --pages <list>        page url or file paths to parse (defaults to ["/"])
    -r, --root                root path or url (required)
    -s, --sitemap [value]     use xml to find pages (defaults to "/sitemap.xml")
    -T, --test                dry run - don't write files (disabled by default)
    -t, --theme-name [value]  name of the theme (defaults to "Custom Theme")
    -v, --version             Output the version number
    -w, --webflow             is a Webflow-based site (disabled by default)
  
  Examples:
    - process remote site
    $ htmlpress --root com --pages /index /single --output my-theme

  

Documentation

Modules

Core

Data attributes providing PHP integrations

• Core
  • php-echo
  • php-if
  • data-attr-src
  • data-attr-style

php-echo

Print the result of php code

Kind: instance method of Core

| Param | Description | | --- | --- | | php_code | the php code to run |

php-if

Print the result of php code

Kind: instance method of Core

| Param | Description | | --- | --- | | php_condition | the php condition to evaluate |

data-attr-src

Replace source attribute

Kind: instance method of Core

| Param | | --- | | name |

data-attr-style

Replace style attribute

Kind: instance method of Core

| Param | | --- | | name |

Wordpress

Data attributes providing Wordpress functionality

• Wordpress
  • wp-loop
  • wp-loop-result
  • wp-menu
  • wp-template

wp-loop

Repeats wp-loop-result element (or else current element) for each repeater

Kind: instance method of Wordpress
See: wp-loop-result

| Param | Type | Description | | --- | --- | --- | | loop_name | ACF_Field | the name of the repeater field |

wp-loop-result

conditionally repeat this element for each repeater entry

Kind: instance method of Wordpress

| Param | Type | Description | | --- | --- | --- | | condition | PHP_Expression | true, or a PHP conditional to evaluate |

wp-menu

Render child tags according to links in a Wordpress Menu

Kind: instance method of Wordpress

| Param | Type | Description | | --- | --- | --- | | menu | WP_Menu_Name | test |

wp-template

Wordpress PHP template file

Kind: instance method of Wordpress

| Param | | --- | | name |

ACF

Advanced Custom Fields integration provider

• ACF
  • acf-block
  • acf-field
  • acf-repeater
  • acf-repeater-row

acf-block

Register block under block_name and render this content

Kind: instance method of ACF

| Param | Description | | --- | --- | | block_name | User-friendly block name to register |

acf-field

Render element according to the given ACF field

Kind: instance method of ACF

| Param | Type | Description | | --- | --- | --- | | field_name | ACF_Field | the name of the repeater field |

acf-repeater

Repeats acf-repeater-row element (or else current element) for each repeater

Kind: instance method of ACF
See: acf-repeater-row

| Param | Type | Description | | --- | --- | --- | | field_name | ACF_Field | the name of the repeater field |

acf-repeater-row

conditionally repeat this element for each repeater entry

Kind: instance method of ACF

| Param | Type | Description | | --- | --- | --- | | condition | PHP_Expression | true, or a PHP conditional to evaluate |