Skip to content

Latest commit

 

History

History
80 lines (48 loc) · 3.61 KB

README.md

File metadata and controls

80 lines (48 loc) · 3.61 KB
Raw

Tainá - A beautiful block theme for WordPress digital archives with support for Tainacan

An open-source, modern, full-site-editing block theme for your digital expositions that works will work with Tainacan.

Tainá is made for museums, libraries and galleries for sharing their stories with the World.

Project design

This project aims to implement this A-M-A-Z-I-N-G design by Marcelo Ávila: Check Tainá design proposal on Behance

Demonstration image

It was designed with Tainacan plugin in mind but should be an awesome theme for anyone using WordPress.

Project development

The idea is to deliver it in three phases:

  • Version 1.0.0 - A simple, yet beautiful block theme for WordPress, available on the themes repository
  • Version 2.0.0 - A block theme that offers nice Tainacan templates, fully customizable
  • Version 3.0.0 - A powerful block theme with some extra options and plugin integrations such as Carousel Banners, Collapsable Search, Sharing, etc. In other words, all the goodies that you can see in the design.

Feel free to contribute with suggestions, pull requests and ideas. We are all new to the block-theme development world here, and we're still trying to learn the best practices. A good way to help is to take a look at our development board.

How to build it

Make the script executable:

chmod u+x build.sh

We use sass to build our style files, so it needs to be compiled. To simply build the necessary .scss files into bundled .css:

./build.sh

To, besides that, move the necessary theme files to your WordPress themes directory:

./build.sh /var/www/html/wp-content/themes/

If you don't like the script you can bundle things by yourself:

cd taina
npm install
npm run build

But keep in mind that the script also takes care of removing some source files not necessary for the theme to work, such as .scss and .package.json.

Just install

If things are already bundled, just move the taina folder to your WordPress themes directory.

F.A.Q.

Will it Work only on latest WordPress versions?

The idea is to make it compatible with WP >= 6.1, since we're using the latest features from the block editor.

What is Tainacan and do I need it to use this theme?

Tainacan is a plugin that extends WordPress functionalities to create a digital repository management and expositions system. While this theme will have templates dedicated to it, you DO NOT need Tainacan to use it, just keep in mind that some screens in the design proposal are related to its collections and items (kinda custom post types). If you want more information about Tainacan, here are three golden links:

What does Tainá stand for?

While the Tainacan plugin had its name inspired by the way that some native people from Brazil call the morning star (Venus), Tainá is a common female name in Brazil, also rooted in indigenous culture.

How about WooCommerce, bbPress, etc integration... ?

Other plugins integration is a bit out of our scope, but feel free to open pull requests and bring some ideas!