https://github.com/atsphinx/color-text

https://github.com/atsphinx/color-text

hacktoberfest html python sphinx sphinx-extension

Last synced: over 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/atsphinx/color-text
• Owner: atsphinx
• License: apache-2.0
• Created: 2023-11-11T11:22:32.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-12-13T18:04:43.000Z (over 2 years ago)
• Last Synced: 2025-02-21T05:16:56.294Z (over 1 year ago)
• Topics: hacktoberfest, html, python, sphinx, sphinx-extension
• Language: Python
• Size: 17.6 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
===================

atsphinx-color-text

===================

.. image:: https://img.shields.io/pypi/v/atsphinx-color-text.svg

   :target: https://pypi.org/project/atsphinx-color-text/

.. image:: https://github.com/atsphinx/color-text/actions/workflows/main.yml/badge.svg

   :target: https://github.com/atsphinx/color-text/actions

Text color changer for Sphinx.

Overview

========

This extension adds simple role to set style of text-color for HTML-based builders.

Getting started

===============

.. code:: console

   pip install atsphinx-color-text

.. code:: python

   extensions = [

       "atsphinx.color_text",

   ]

Usage

=====

Write your text with ``:color:`` role.

.. code:: rst

   Your title

   ==========

   sphinx-revealjs is presentation library for Pythonista using reStructuredText and :color:red:`Sphinx`.

When you generate HTML by ``sphinx-build -b html`` ,

"Sphinx" rendered as red color by CSS ( likely ``font-color: red;`` ).

Notes and ToDo

==============

I will not implements all color-names, but plan "RGB code" mode and custom name mode.