Skip to content

Commit

Permalink
update documentation (#148)
Browse files Browse the repository at this point in the history
* Configuration for Non-HTML Responses

* Supported Meta Tags

* update description

* Update README.rst

Minor edits

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: Brahim Chamakh <brahim.chamakh@medtech.tn>
Co-authored-by: Iacopo Spalletti <github@spalletti.it>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
  • Loading branch information
4 people committed Apr 20, 2023
1 parent 7c92488 commit 15ced00
Showing 1 changed file with 32 additions and 2 deletions.
34 changes: 32 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@ django-meta

|Gitter| |PyPiVersion| |PyVersion| |GAStatus| |TestCoverage| |CodeClimate| |License|

This pluggable app allows Django developers to quickly add meta tags and
OpenGraph_, Twitter, and Schema.org properties to their HTML responses.
Django-Meta is a pluggable Django app that allows developers to easily add meta tags and OpenGraph,
Twitter, and Schema.org properties to their HTML responses.

By adding these tags to their pages, developers can improve the way their pages are displayed in search engine results and on social media platforms.

.. warning:: **INCOMPATIBLE CHANGE**: as of version 2.0 django-meta has no
longer supports Google+, basic Schema.org support has been introduced.
Expand Down Expand Up @@ -35,6 +37,23 @@ Python

Python 3.9 to 3.11

*******************
Supported Meta Tags
*******************

Django-Meta supports a wide range of meta tags, including:

- Description
- Keywords
- Robots
- Author
- Google Analytics
- Open Graph (OG) tags
- Twitter Cards
- Schema.org properties

To add meta tags to your pages using Django-Meta, you can use the provided template tags or use the view-method and model-method interface to provide and handle meta information.

*************
Basic concept
*************
Expand All @@ -43,6 +62,17 @@ Basic concept

For more details check `documentation`_.

************************************
Configuration for Non-HTML Responses
************************************

By default, Django-Meta is designed to work with HTML responses.

However, it can also be configured to work with non-HTML responses, such as JSON or XML.

To do this, you can define your own meta classes and register them with the django-meta app.


**************************
Authors and Contributors
**************************
Expand Down

0 comments on commit 15ced00

Please sign in to comment.