Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/collective/plonetheme.tokyo

A Theme for Plone
https://github.com/collective/plonetheme.tokyo

Last synced: 3 months ago
JSON representation

A Theme for Plone

Lists

README

        

.. This README is meant for consumption by humans and pypi. Pypi can render rst files so please do not use Sphinx features.
If you want to learn more about writing documentation, please check out: http://docs.plone.org/about/documentation_styleguide.html
This text does not appear on pypi or github. It is a comment.

========================================
Tokyo Theme for Plone (plonetheme.tokyo)
========================================

Tokyo Theme for Plone implements Bootstrap 4 into Plone, with an emphasis on keeping things as close to "default" as possible.

Mostly Harmless
---------------

.. build status

.. image:: https://img.shields.io/github/workflow/status/collective/plonetheme.tokyo/Build/1.x?label=Build
:target: https://github.com/collective/plonetheme.tokyo/actions/workflows/build.yml
:alt: Build Status

.. coverage

.. image:: https://coveralls.io/repos/github/collective/plonetheme.tokyo/badge.svg?branch=1.x
:target: https://coveralls.io/github/collective/plonetheme.tokyo?branch=1.x
:alt: Code Coverage

.. pypi version

.. image:: https://img.shields.io/pypi/v/plonetheme.tokyo.svg?label=PyPI
:target: https://pypi.python.org/pypi/plonetheme.tokyo/
:alt: Latest Version

.. supported python versions

.. image:: https://img.shields.io/pypi/pyversions/plonetheme.tokyo.svg?label=Python
:target: https://pypi.python.org/pypi/plonetheme.tokyo/
:alt: Supported Python Versions

.. licence

.. image:: https://img.shields.io/pypi/l/plonetheme.tokyo.svg?label=Licence
:target: https://pypi.python.org/pypi/plonetheme.tokyo/
:alt: License

Frontpage
---------

.. image:: https://raw.githubusercontent.com/collective/plonetheme.tokyo/1.x/docs/frontpage.png
:target: https://raw.githubusercontent.com/collective/plonetheme.tokyo/1.x/docs/frontpage.png

Sidebar
-------

.. image:: https://raw.githubusercontent.com/collective/plonetheme.tokyo/1.x/docs/sidebar.png
:target: https://raw.githubusercontent.com/collective/plonetheme.tokyo/1.x/docs/sidebar.png

Mobile
------

.. image:: https://raw.githubusercontent.com/collective/plonetheme.tokyo/1.x/docs/mobile.png
:target: https://raw.githubusercontent.com/collective/plonetheme.tokyo/1.x/docs/mobile.png

Demo
----

- https://plonetheme.tokyo/

Features
--------

- Responsive mobile first theme for Plone
- No Dependencies to Barceloneta
- No Diazo Rules
- No Toolbar
- No Portlets
- Plone patterns still persistent
- Default Bootstrap 5 for form fields and views
- Bootstrap 5 components and JavaScript
- Bootstrap Icons are available
- Uses https://github.com/collective/collective.sidebar

Documentation
-------------

Full documentation for end users can be found in the "docs" folder.

Credits
-------

This theme is developed and maintained by `operun Digital Solutions `_. Check out other `projects `_ we developed based on the `Enterprise Content Management System `_ Plone.

Translations
------------

This product has been translated into:

- English (thanks, Netroxen)
- German (thanks, santonelli)
- Czech (thanks, olda-a)

Known Issues
------------

- Some missing view overrides
- Some unstyled form widgets and fields

Some views implement custom forms that do not use `z3c.form`. In these cases it's possible the form fields may be styled incorrectly. We encourage users to report missing, broken or incomplete views (see below).

Installation
------------

Install plonetheme.tokyo by adding it to your buildout::

[buildout]

...

eggs =
plonetheme.tokyo

and then running ``bin/buildout``...

Versions
--------

- Version 0.x and 1.x works with Plone 5.2
- Version 2.x works with Plone 6

Contribute
----------

- Issue Tracker: https://github.com/collective/plonetheme.tokyo/issues
- Source Code: https://github.com/collective/plonetheme.tokyo

Support
-------

If you are having issues, please let us know. We have a issue tracker located at: https://github.com/collective/plonetheme.tokyo/issues

License
-------

The project is licensed under the GPLv2.