Socket
Socket
Sign inDemoInstall

lektor-markdown-highlighter

Package Overview
Dependencies
1
Maintainers
5
Alerts
File Explorer

Install Socket

Protect your apps from supply chain attacks

Install

lektor-markdown-highlighter

Lektor plugin that adds syntax highlighting for markdown blocks with Pygments.

    0.3.2

Maintainers
5

Readme

lektor-markdown-highlighter

This plugin adds support for syntax highlighting through Pygments to Lektor's markdown support.

Enabling the Plugin

To enable the plugin run this command:

lektor plugins add markdown-highlighter

Configuring the Plugin

The plugin has a config file that is used to configure a few things for Pygments. Just create a file named markdown-highlighter.ini into your configs/ folder. Currently only pygments.style is used:

[pygments]
style = tango

You can use this to select any of the built-in Pygments styles. Support for custom styles will come in the future.

The config file is considered the "source" for the Pygments stylesheet, so you must create the configuration file (it can be empty) or Lektor's build will prune pygments.css.

In Markdown

To use the syntax highlighter you need to use fenced blocks and pass the name of the pygments lexer after the opening fence:

```python
print("Hello World!")
```

In Templates

In templates the plugin provides the get_pygments_stylesheet function which can be used to generate and retrieve a link to the pygments stylesheet:

<link rel="stylesheet" href="{{ get_pygments_stylesheet()|url }}">

In addition the |pygmentize filter can be used to highlight code from templates. It takes one argument which is the lexer name:

{{ 'print "Hello World!"'|pygmentize('python') }}

Keywords

FAQs


Did you know?

Socket installs a GitHub app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc