Metadata-Version: 2.1
Name: wagtailcodeblock
Version: 1.14.0.0
Summary: Wagtail Code Block provides PrismJS syntax highlighting in Wagtail.
Home-page: https://github.com/FlipperPA/wagtailcodeblock
Author: Tim Allen
Author-email: tallen@wharton.upenn.edu
License: UNKNOWN
Description: # Wagtail Code Block
        
        Wagtail Code Block is a syntax highlighted block for source code for the Wagtail CMS. It features real-time highlighting in the Wagtail editor, the front end, line numbering, and support for PrismJS themes.
        
        It uses the [PrismJS](http://prismjs.com/) library both in Wagtail Admin and the website and requires jQuery.
        
        ## Example Usage
        
        ```python
        from wagtailcodeblock.blocks import CodeBlock
        
        class ContentStreamBlock(StreamBlock):
            heading = TextBlock()
            paragraph = TextBlock()
            code = CodeBlock(label='Code')
        ```
        
        You can also force it to use a single language by providing a language code which must be included in your `WAGTAIL_CODE_BLOCK_LANGUAGES` setting:
        
        ```python
        code = CodeBlock(label='Bash Code', language='bash')
        ```
        
        ## Screenshot of the CMS Editor Interface
        
        ![Admin in Action](img/screenshot-editor.png)
        
        ## Installation & Setup
        
        To install Wagtail Code Block simply run:
        
        `pip install wagtailcodeblock`
        
        And add `wagtailcodeblock` to your `INSTALLED_APPS` setting:
        
        ```python
        INSTALLED_APPS = [
            ...
            'wagtailcodeblock',
            ...
        ]
        ``` 
        
        ## Django Settings
        
        ### Themes
        
        Wagtail Code Block defaults to the PrismJS "Coy" theme, which looks good with Wagtail's CMS editor design. You can choose a different theme by configuring `WAGTAIL_CODE_BLOCK_THEME` in your Django settings. PrismJS provides several themes:
        
        * **None**: <a href="http://prismjs.com/index.html?theme=prism" target="_blank">Default</a>
        * **'coy'**: <a href="http://prismjs.com/index.html?theme=prism-coy" target="_blank">Coy</a>
        * **'dark'**: <a href="http://prismjs.com/index.html?theme=prism-dark" target="_blank">Dark</a>
        * **'funky'**: <a href="http://prismjs.com/index.html?theme=prism-funky" target="_blank">Funky</a>
        * **'okaidia'**: <a href="http://prismjs.com/index.html?theme=prism-okaidia" target="_blank">Okaidia</a>
        * **'solarizedlight'**: <a href="http://prismjs.com/index.html?theme=prism-solarizedlight" target="_blank">Solarized Light</a>
        * **'twilight'**: <a href="http://prismjs.com/index.html?theme=prism-twilight" target="_blank">Twilight</a>
        
        For example, in you want to use the Solarized Light theme: `WAGTAIL_CODE_BLOCK_THEME = 'solarizedlight'`
        If you want to use the Default theme: `WAGTAIL_CODE_BLOCK_THEME = None`
        
        ### Languages Available
        
        You can customize the languages available by configuring `WAGTAIL_CODE_BLOCK_LANGUAGES` in your Django settings.
        By default, it will be set with these languages, since most users are in the Python web development community:
        
        ```python
        WAGTAIL_CODE_BLOCK_LANGUAGES = (
            ('bash', 'Bash/Shell'),
            ('css', 'CSS'),
            ('diff', 'diff'),
            ('html', 'HTML'),
            ('javascript', 'Javascript'),
            ('json', 'JSON'),
            ('python', 'Python'),
            ('scss', 'SCSS'),
            ('yaml', 'YAML'),
        )
        ```
        
        Each language in this setting is a tuple of the PrismJS code and a descriptive label. If you want use all available languages, here is a list:
        
        ```python
        WAGTAIL_CODE_BLOCK_LANGUAGES = (
            ('abap', 'ABAP'),
            ('actionscript', 'ActionScript'),
            ('ada', 'Ada'),
            ('apacheconf', 'Apache Configuration'),
            ('apl', 'APL'),
            ('applescript', 'AppleScript'),
            ('arduino', 'Arduino'),
            ('arff', 'ARFF'),
            ('asciidoc', 'AsciiDoc'),
            ('asm6502', '6502 Assembly'),
            ('aspnet', 'ASP.NET (C#)'),
            ('autohotkey', 'AutoHotkey'),
            ('autoit', 'AutoIt'),
            ('bash', 'Bash'),
            ('basic', 'BASIC'),
            ('batch', 'Batch'),
            ('bison', 'Bison'),
            ('brainfuck', 'Brainfuck'),
            ('bro', 'Bro'),
            ('c', 'C'),
            ('clike', 'C-like'),
            ('csharp', 'C#'),
            ('cpp', 'C++'),
            ('coffeescript', 'CoffeeScript'),
            ('clojure', 'Clojure'),
            ('crystal', 'Crystal'),
            ('csp', 'Content-Security-Policy'),
            ('css', 'CSS'),
            ('css-extras', 'CSS Extras'),
            ('d', 'D'),
            ('dart', 'Dart'),
            ('diff', 'Diff'),
            ('django', 'Django/Jinja2'),
            ('docker', 'Docker'),
            ('eiffel', 'Eiffel'),
            ('elixir', 'Elixir'),
            ('elm', 'Elm'),
            ('erb', 'ERB'),
            ('erlang', 'Erlang'),
            ('fsharp', 'F#'),
            ('flow', 'Flow'),
            ('fortran', 'Fortran'),
            ('gedcom', 'GEDCOM'),
            ('gherkin', 'Gherkin'),
            ('git', 'Git'),
            ('glsl', 'GLSL'),
            ('go', 'Go'),
            ('graphql', 'GraphQL'),
            ('groovy', 'Groovy'),
            ('haml', 'Haml'),
            ('handlebars', 'Handlebars'),
            ('haskell', 'Haskell'),
            ('haxe', 'Haxe'),
            ('http', 'HTTP'),
            ('hpkp', 'HTTP Public-Key-Pins'),
            ('hsts', 'HTTP Strict-Transport-Security'),
            ('ichigojam', 'IchigoJam'),
            ('icon', 'Icon'),
            ('inform7', 'Inform 7'),
            ('ini', 'Ini'),
            ('io', 'Io'),
            ('j', 'J'),
            ('java', 'Java'),
            ('javascript', 'JavaScript'),
            ('jolie', 'Jolie'),
            ('json', 'JSON'),
            ('julia', 'Julia'),
            ('keyman', 'Keyman'),
            ('kotlin', 'Kotlin'),
            ('latex', 'LaTeX'),
            ('less', 'Less'),
            ('liquid', 'Liquid'),
            ('lisp', 'Lisp'),
            ('livescript', 'LiveScript'),
            ('lolcode', 'LOLCODE'),
            ('lua', 'Lua'),
            ('makefile', 'Makefile'),
            ('markdown', 'Markdown'),
            ('markup', 'Markup'),
            ('markup-templating', 'Markup templating'),
            ('matlab', 'MATLAB'),
            ('mel', 'MEL'),
            ('mizar', 'Mizar'),
            ('monkey', 'Monkey'),
            ('n4js', 'N4JS'),
            ('nasm', 'NASM'),
            ('nginx', 'nginx'),
            ('nim', 'Nim'),
            ('nix', 'Nix'),
            ('nsis', 'NSIS'),
            ('objectivec', 'Objective-C'),
            ('ocaml', 'OCaml'),
            ('opencl', 'OpenCL'),
            ('oz', 'Oz'),
            ('parigp', 'PARI/GP'),
            ('parser', 'Parser'),
            ('pascal', 'Pascal'),
            ('perl', 'Perl'),
            ('php', 'PHP'),
            ('php-extras', 'PHP Extras'),
            ('plsql', 'PL/SQL'),
            ('powershell', 'PowerShell'),
            ('processing', 'Processing'),
            ('prolog', 'Prolog'),
            ('properties', '.properties'),
            ('protobuf', 'Protocol Buffers'),
            ('pug', 'Pug'),
            ('puppet', 'Puppet'),
            ('pure', 'Pure'),
            ('python', 'Python'),
            ('q', 'Q (kdb+ database)'),
            ('qore', 'Qore'),
            ('r', 'R'),
            ('jsx', 'React JSX'),
            ('tsx', 'React TSX'),
            ('renpy', 'Ren\'py'),
            ('reason', 'Reason'),
            ('rest', 'reST (reStructuredText)'),
            ('rip', 'Rip'),
            ('roboconf', 'Roboconf'),
            ('ruby', 'Ruby'),
            ('rust', 'Rust'),
            ('sas', 'SAS'),
            ('sass', 'Sass (Sass)'),
            ('scss', 'Sass (Scss)'),
            ('scala', 'Scala'),
            ('scheme', 'Scheme'),
            ('smalltalk', 'Smalltalk'),
            ('smarty', 'Smarty'),
            ('sql', 'SQL'),
            ('soy', 'Soy (Closure Template)'),
            ('stylus', 'Stylus'),
            ('swift', 'Swift'),
            ('tcl', 'Tcl'),
            ('textile', 'Textile'),
            ('tt2', 'Template Toolkit 2'),
            ('twig', 'Twig'),
            ('typescript', 'TypeScript'),
            ('vbnet', 'VB.Net'),
            ('velocity', 'Velocity'),
            ('verilog', 'Verilog'),
            ('vhdl', 'VHDL'),
            ('vim', 'vim'),
            ('visual-basic', 'Visual Basic'),
            ('wasm', 'WebAssembly'),
            ('wiki', 'Wiki markup'),
            ('xojo', 'Xojo (REALbasic)'),
            ('yaml', 'YAML'),
            ('xeora', 'Xeora'),
        )
        ```
        
        # Change Log
        
        ## 1.14.0.0
        
        * Upgrade to PrismJS 1.14.0
        * Allow passing a language code as an attribute, only allowing the single language to be used.
        * Fix conflict in CSS between `tag` class for Wagtail and markup syntax types.
        
        ## 1.11.0.0
        
        * Upgrade to PrismJS 1.11.0
            * Changed version numbers to match the included PrismJS release
        * Patch to add support for natively included PrismJS languages ['html', 'mathml', 'svg', 'xml']
        
        ## 0.4
        
        * Support for Wagtail 2.0
        
        ### 0.4.1
        
        * Upgrade to PrismJS 1.9.0, which includes a patch we made to the 'coy' theme we use as a default.
        
        ## 0.3
        
        * Support for PrismJS themes
        
        ### 0.3.1
        
        * Bug fixes for some front-end issues. Update documentation.
        
        # Project Maintainers
        
        * Timothy Allen (https://github.com/FlipperPA)
        * Milton Lenis (https://github.com/MiltonLn)
        
        # Contributors
        
        * José Luis (https://github.com/SalahAdDin)
        * Nick Sarbicki (https://github.com/NDevox)
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Framework :: Django
Classifier: Framework :: Wagtail
Classifier: Framework :: Wagtail :: 2
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Description-Content-Type: text/markdown
