Version 0.1.2: Prepares files for WordPress Repo
This commit is contained in:
mateuswetah
parent
df4563e495
commit
3339960bfd
28
README.md
28
README.md
|
|
@ -37,3 +37,31 @@ npm run build
|
|||
```
|
||||
|
||||
But keep in mind that the script also takes care of removing some source files not necessary for the plugin to work, such as `.scss` and `.package.json`.
|
||||
|
||||
## After all, a Plugin or a Child Theme?
|
||||
|
||||
By default, it is a plugin. While the most traditional strategy for creating themes compatible to Tainacan is to add some pages to the theme directly or using a child theme, this project goes the other way, which is to use it as plugin. The reason is clear: developers might prefer to create child themes of Blocksy by their own, without creating forks of this project. It is although a not-very-canonical approach, so you might be more comfortable using it as child theme.
|
||||
|
||||
## How to use it?
|
||||
|
||||
### As a plugin:
|
||||
|
||||
Just move all files to a folder inside WordPress plugins folder (`wp-content/plugins`) (which is what the script does);
|
||||
|
||||
Download and activate the Blocksy. And Tainacan, of course;
|
||||
|
||||
Then you just have to enable Blocksy theme and have fun ;)
|
||||
|
||||
### As a child theme:
|
||||
|
||||
Just go to `functions.php` file and set the constant as you prefer:
|
||||
|
||||
```php
|
||||
const BLOCKSY_TAINACAN_IS_CHILD_THEME = true;
|
||||
```
|
||||
|
||||
Then move all files to a folder inside WordPress themes folder (`wp-content/themes`);
|
||||
|
||||
Download the Blocksy parent theme. And Tainacan, of course;
|
||||
|
||||
Go ahead, enable the child theme and have fun ;)
|
||||
|
|
|
|||
|
|
@ -1,47 +0,0 @@
|
|||
# Blocksy Tainacan
|
||||
|
||||
## What is this about?
|
||||
|
||||
This project contains the source code necessary for integrating Tainacan pages to Blocksy theme. It allows you to choose between two strategies: either having a child theme or a plugin that does the job.
|
||||
|
||||
### But wait, what is Tainacan?
|
||||
|
||||
Tainacan is an open-source, flexible and powerful tool for creating digital repositories on WordPress. It allows you to create and manage collections with a variety of metadata types, rich search and filtering of items and much more. You can learn about it on our official website:
|
||||
|
||||
https://tainacan.org
|
||||
|
||||
### And how about Blocksy?
|
||||
|
||||
Blocksy is one of the many WordPress themes available out there. But it is not just another theme, it offers rich controls to customize your site with so many features that you won't miss a page builder:
|
||||
|
||||
https://creativethemes.com/blocksy/
|
||||
|
||||
This project uses their customizer controls to offer options for setting different layouts to Tainacan pages such as the collection items list and the items page.
|
||||
|
||||
## After all, a Plugin or a Child Theme?
|
||||
|
||||
By default, it is a plugin. While the most traditional strategy for creating themes compatible to Tainacan is to add some pages to the theme directly or using a child theme, this project goes the other way, which is to use it as plugin. The reason is clear: developers might prefer to create child themes of Blocksy by their own, without creating forks of this project. It is although a not-very-canonical approach, so you might be more comfortable using it as child theme.
|
||||
|
||||
## How to use it?
|
||||
|
||||
### As a plugin:
|
||||
|
||||
Just move all files to a folder inside WordPress plugins folder (`wp-content/plugins`);
|
||||
|
||||
Download and activate the Blocksy. And Tainacan, of course;
|
||||
|
||||
Then you just have to enable Blocksy theme and have fun ;)
|
||||
|
||||
### As a child theme:
|
||||
|
||||
Just go to `functions.php` file and set the constant as you prefer:
|
||||
|
||||
```php
|
||||
const BLOCKSY_TAINACAN_IS_CHILD_THEME = true;
|
||||
```
|
||||
|
||||
Then move all files to a folder inside WordPress themes folder (`wp-content/themes`);
|
||||
|
||||
Download the Blocksy parent theme. And Tainacan, of course;
|
||||
|
||||
Go ahead, enable the child theme and have fun ;)
|
||||
|
|
@ -0,0 +1,55 @@
|
|||
=== Blocksy Tainacan ===
|
||||
Author: tainacan
|
||||
Contributors: wetah, vnmedeiros, leogermani, tainacan
|
||||
Tags: museums, libraries, archives, GLAM, collections, repository, tainacan, blocksy
|
||||
Requires at least: 5.0
|
||||
Tested up to: 5.6
|
||||
Requires PHP: 5.6
|
||||
Stable tag: 0.1.2
|
||||
License: GPLv2 or later
|
||||
License URI: http://www.gnu.org/licenses/gpl-3.0.html
|
||||
|
||||
|
||||
A plugin for integrating Tainacan plugin pages with the amazing Blocksy theme.
|
||||
|
||||
|
||||
== Description ==
|
||||
|
||||
[Tainacan](https://tainacan.org/) is an open-source, flexible and powerful tool for creating digital repositories on WordPress. It allows you to create and manage collections with a variety of metadata types, rich search and filtering of items and much more.
|
||||
|
||||
[Blocksy](https://creativethemes.com/blocksy/) is one of the many WordPress themes available out there. But it is not just another theme, it offers rich controls to customize your site with so many features that you won't miss a page builder. This project uses their customizer controls to offer options for setting different layouts to Tainacan pages such as the collection items list and the items page.
|
||||
|
||||
This project uses their customizer controls to offer options for setting different layouts to Tainacan pages such as the collection items list and the items page.
|
||||
|
||||
|
||||
== Installation ==
|
||||
|
||||
Upload the files to the plugins directory and activate it. You can also install and activate directly from the admin panel.
|
||||
|
||||
Once activated, go to the theme customizer and play around with Tainacan-related options for each of your collections.
|
||||
|
||||
This plugin will only work with [Tainacan plugin](https://wordpress.org/plugins/tainacan/) active, preferably with a version greater than or equal to 0.18;
|
||||
|
||||
This plugin will only work with [Blocksy theme](https://wordpress.org/themes/blocksy/) active, preferably with a version greater than or equal to 1.7.0;
|
||||
|
||||
|
||||
== Find out more ==
|
||||
|
||||
* Visit our official website: [https://tainacan.org/](https://tainacan.org/)
|
||||
* Check our documentation Wiki: [https://wiki.tainacan.org/](https://wiki.tainacan.org/)
|
||||
* Source code on GitHub: [https://github.com/tainacan/blocksy-tainacan](https://github.com/tainacan/blocksy-tainacan)
|
||||
* Blocksy official website: [https://creativethemes.com/blocksy/](https://creativethemes.com/blocksy/)
|
||||
* Blocksy Companion plugin: [https://wordpress.org/plugins/blocksy-companion/](https://wordpress.org/plugins/blocksy-companion/)
|
||||
|
||||
|
||||
== Copyright ==
|
||||
|
||||
Blocksy Tainacan, Copyright 2021 Tainacan.org
|
||||
Blocksy Tainacan plugin is distributed under the terms of the GNU GPLv3
|
||||
License details: https://github.com/tainacan/blocksy-tainacan/blob/master/LICENSE
|
||||
|
||||
|
||||
== Changelog ==
|
||||
|
||||
= 0.1.2 =
|
||||
* First release on the WordPress.org plugins repository
|
||||
|
|
@ -4,7 +4,7 @@ Plugin Name: Blocksy Tainacan
|
|||
Plugin URI: https://tainacan.org/
|
||||
Description: Tainacan support for Blocksy theme
|
||||
Author: tainacan
|
||||
Version: 0.1.1
|
||||
Version: 0.1.2
|
||||
Text Domain: blocksy-tainacan
|
||||
License: GPLv2 or later
|
||||
License URI: http://www.gnu.org/licenses/gpl-3.0.html
|
||||
|
|
@ -15,7 +15,7 @@ if (! defined('WP_DEBUG') ) {
|
|||
}
|
||||
|
||||
/** Theme/plugin version */
|
||||
const BLOCKSY_TAINACAN_VERSION = '0.1.1';
|
||||
const BLOCKSY_TAINACAN_VERSION = '0.1.2';
|
||||
const BLOCKSY_TAINACAN_IS_CHILD_THEME = false;
|
||||
|
||||
/* Tools to define our next constants */
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "blocksy-tainacan",
|
||||
"version": "0.1.1",
|
||||
"version": "0.1.2",
|
||||
"lockfileVersion": 1,
|
||||
"requires": true,
|
||||
"dependencies": {
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"name": "blocksy-tainacan",
|
||||
"version": "0.1.1",
|
||||
"description": "A Blocksy child theme compatible with Tainacan",
|
||||
"version": "0.1.2",
|
||||
"description": "A Blocksy plugin/child theme compatible with Tainacan",
|
||||
"main": "index.js",
|
||||
"scripts": {
|
||||
"compile-styles": "node-sass --output-style expanded --source-map true --source-map-contents true --precision 6 sass/style.scss style.css",
|
||||
|
|
|
|||
Loading…
Reference in New Issue