Skip to content

Fix markdown headings #6

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.

Sign up for GitHub

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

Open
artifex404 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix markdown headings #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@

##Requirements
## Requirements
You must be using [Timber](https://github.com/jarednova/timber) for WordPress.

##Installation
## Installation
run `npm install --save wp-timber-cli` inside your root WordPress theme directory.

##Usage
## Usage
Timber CLI will create a WordPress PHP template and corresponding twig template and automatically create some default Timber stuff.

###Create Templates
### Create Templates
From the command line, run `wp-timber -c <type> <name>` where type is the type of template (page, single, archive) and name is, you guessed it, the name of the template.

**Example Output**
Expand All @@ -31,7 +31,7 @@ Timber::render("/views/pages/page-test.twig", $context);
?>
```

###Create Query
### Create Query
You can create a basic WordPress query for an existing page template, or when create a new template using this CLI.

**Existing Template**
Expand Down Expand Up @@ -61,13 +61,13 @@ Timber::render("/views/pages/page-about.twig", $context);
```


###Remove Templates
### Remove Templates

`wp-timber -r page about-us`

This will find a .php template called `page-about-us.php` in the root theme directory and delete it, as well as the corresponding twig template in `/views/pages/`.

###Create Subclasses
### Create Subclasses

Create a subclass of a built-in Timber class (TimberPost, TimberTerm etc.) in the lib directory by running `wp-timber -s <class> <name>`, where class refers to the class to extend and name is the name assigned to the new subclass. Site, term, post, menu, menuitem, and user are all accepted as arguments for the base class.

Expand All @@ -88,7 +88,7 @@ Class TestPost extends TimberPost {

This will find a .php template called `page-about-us.php` in the root theme directory and delete it, as well as the corresponding twig template in `/views/pages/`.

###Build from a Config file
### Build from a Config file
With Timber CLI you can generate a series of templates with queries from a configuration file. Create a `.timber` file that contains JSON to generate as many templates with queries as you want.

Here's an example config file:
Expand Down