Skip to content
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.

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

Documentation Updates #1

Merged
merged 8 commits into from
Mar 29, 2019
28 changes: 16 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,22 @@
* [License](#license)

## Install
1. Install [Node](https://nodejs.org/en/).
2. Install [Yarn](https://yarnpkg.com/lang/en/docs/install/).
3. Install [Composer](https://getcomposer.org/download/).
4. Create a new project folder and setup a new [WordPress](https://wordpress.org/download/) installation.
5. Install and activate [Advanced Custom Fields Pro](https://www.advancedcustomfields.com/pro/).
6. Clone this repo to `<your-project>/wp-content/themes`.
7. Change the host variable in `flynt/build-config.js` to match your host URL.
```js
const host = 'your-project.test'

1. Clone this repo to `<your-project>/wp-content/themes`.
2. Change the host variable in `flynt/build-config.js` to match your host URL: `const host = 'your-project.test'`
3. Navigate to the theme folder and run the following command in your terminal:
```
# wp-content/themes/flynt
composer install && yarn && yarn build
```
8. In your terminal, navigate to `<your-project>/wp-content/themes/flynt`. Run `composer install && yarn && yarn build`.
9. Open the WordPress back-end and activate the Flynt theme.
4. Open the WordPress back-end and activate the Flynt theme.

### Dependencies
* [WordPress](https://wordpress.org/) >= 5.0
* [Node](https://nodejs.org/en/) = 10
* [Yarn](https://yarnpkg.com/lang/en/docs/install/) >= 1.15
* [Composer](https://getcomposer.org/download/) >= 1.8
* [Advanced Custom Fields Pro](https://www.advancedcustomfields.com/pro/) >= 5.7

## Usage
In your terminal, navigate to `<your-project>/wp-content/themes/flynt` and run `yarn start`. This will start a local server at `localhost:3000`.
Expand All @@ -51,7 +55,7 @@ The `admin.scss` file is compiled to `./dist/assets/admin.css` which is enqueued

### Lib & Inc

All PHP files from `./lib` and './inc' are automatically required.
All PHP files from `./lib` and `./inc` are automatically required.

The `./lib` folder includes helper functions and basic setup logic. *You will most likely not need to modify any files inside `./lib`.*

Expand Down
87 changes: 0 additions & 87 deletions inc/tinyMce.md

This file was deleted.

13 changes: 3 additions & 10 deletions inc/tinyMce.php
Original file line number Diff line number Diff line change
@@ -1,17 +1,10 @@
<?php

/**
* Cleans up TinyMCE Buttons to show all relevant buttons on the first bar. Adds an easy to configure way to change these defaults.
* Moves most relevant editor buttons to the first toolbar
* and provides config for creating new toolbars, block formats, and style formats.
* See the TinyMce documentation for more information: https://www.tiny.cloud/docs/
*
*
* ## Updating global TinyMce settings using the JSON config
*
* By updating the function `getConfig` you can easily add new **Block Formats**, **Style Formats** and **Toolbars** for all Wysiwyg editors in your project.
*
* ## Editor Toolbars
*
* The MCE Buttons that show up by default are specified by the `toolbars` section in the `getConfig` function.
* You can modify the settings for all Wysiwyg toolbars (all over your project).
*/
namespace Flynt\TinyMce;

Expand Down