gen-pygments-css 0.0.3

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
   • Install With PIP
   • Install From Source
   • Usage
3. Roadmap
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

Generate CSS stylesheets for each Pygments supported style.

• Github Link: https://github.com/hreikin/gen-pygments-css
• PyPi Link: https://pypi.org/project/gen-pygments-css/
• PDF Documentation: https://hreikin.github.io/gen-pygments-css/pdf/gen-pygments-css-documentation-LATEST.pdf

(back to top)

Built With

• Pygments
• Python

(back to top)

Getting Started

Installation

To get a local copy up and running choose one of the below install instructions and follow the steps provided.

Install With PIP

The simplest way to install gen-pygments-css is to use pip:

pip install gen-pygments-css

Install From Source

Alternatively you can install from source by following the steps below:

1. Clone the repo:

   git clone https://github.com/hreikin/gen-pygments-css.git
   cd gen-pygments-css/
   

2. Create and source a Python virtual environment:

   python3 -m venv .venv
   source .venv/bin/activate
   

3. Install requirements with pip:

   pip install -r requirements.txt
   

(back to top)

Usage

CSS stylesheets for all Pygments styles are output into a created css/ directory by default, this can be overridden.

from gen_pygments_css.gen_pygments_css import gen_pygments_css
        
# Called with no arguments.
gen_pygments_css()
       
# Called with a string passed into the styles_list.
gen_pygments_css(styles_list="monokai")
        
# Called with a list of strings passed into the styles_list.
gen_pygments_css(styles_list=["monokai", "stata-dark"])
       
# Call with a CSS selector defined.
gen_pygments_css(css_selector=".highlight")

# Call with a multiple arguments defined.
gen_pygments_css(css_selector=".highlight", styles_list=["monokai", "stata-dark"])

# Call with a relative custom css_dir.
gen_pygments_css(css_dir="assets/styles/")

# Call with an absolute custome css_dir.
gen_pygments_css(css_dir="/home/user/project/assets/styles/")
        
# Call the function and create a list of strings containing the paths of all 
# stylesheets.
my_list = gen_pygments_css()

For more examples, please refer to the Documentation

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Github Link: https://github.com/hreikin/gen-pygments-css
PyPi Link: https://pypi.org/project/gen-pygments-css/
PDF Documentation: https://hreikin.github.io/gen-pygments-css/pdf/gen-pygments-css-documentation-LATEST.pdf

(back to top)