Code Snippet DM

Omschrijving

Display your code snippets in a stylish way inside your content. The plugin uses shortcodes and also very intuitive TinyMCE interface.

Code Snippet DM was inspired by the Carbon project.
We created a simple way to display your code snippets but also have control over the way it appears, thus making it more stylish.
Also, on the front end in the top right you will find a Copy Code button that allows you to copy to clipboard the entired code snippet.

The plugin provides you with a TinyMCE button that will allow you to display the code or an option to use a shortcode.

You can open the shorcode [dm_code_snippet] and in the content inside and close it [/dm_code_snippet].

Options

There are a number of options that you can use in the shortcode:

  • background with options yes or no will enable/disable the color background (Default yes)
  • background-mobile with options yes or no will enable/disable the color background for mobile devices (Default yes)
  • bg-color accepts any HEX, RGB or RGBA value to change the background color (Default #abb8c3)
  • theme with options light or dark that changes the code editor theme (Default dark)
  • slim with options yes or no that changes the code editor from default to a slim version, ideal for one-line code (Default no)
  • language with options clike, css, javascript, markup, perl, php, python, ruby, sql, typescript will highlight the syntaxes based on what you select for your code (Default php)
  • wrap with options yes or no will wrap the code or add a horizontal scroll bar to display it as it is (Default no)
  • height allows you to input any value and will set the code snippet height to that value. Example: 500px. (Default is empty)
  • copy-text this is used for the text shown on the copy button. If it’s not added it will use the default option. (Default Copy Code)
  • copy-confirmed this is used for the text shown after you click the copy button. If it’s not added it will use the default option. (Default Copied)

Example of shortcode:

[dm_code_snippet background="yes" background-mobile="yes" slim="no" bg-color="#abb8c3" theme="light" language="css" wrapped="no" height="500px" copy-text="Get the Code!" copy-confirmed="You have it!"]<pre>
.dm-code-snippet.dark {
  background: $default-bg;
  padding: 40px 35px 45px 35px;
  margin: 30px 0;
}</pre>
[/dm_code_snippet]

Important:
* If you use the shortcode directly, make sure to wrap the code in <pre></pre> as in the example above.
* If you want to add HTML using the shortcode, you’ll need to escape the HTML before pasting it in the shortcode. (You can easily find an escape tool online to convert the code)
* If you have code (not HTML) that uses ‘</’ and you add it with the shortcode and not the and the TinyMCE button, you will need to escape ‘</’ from your code in order to properly display it.

Use the TinyMCE button if you don’t want to add the shortcode yourself. (see Screenshots)

Schermafdrukken

  • DM Code Snippet TinyMCE button
  • How to add the code using the TinyMCE button
  • Example of shortcode added via TinyMCE
  • Front end example of a dark theme
  • Front end example of a dark theme with the background disabled
  • Front end example of a light theme
  • Front end example of a light theme with the background disabled
  • Slim option with one-line code

Installatie

  1. Upload code-snippet-dm folder to the /wp-content/plugins/ directory.
  2. Activate the plugin through the ‘Plugins’ menu in WordPress.
  3. Start using the shortcode or TinyMCE button to display your code.

FAQ

Can I see a live demo?

Sure! Check it out here

The code indentation doesn’t look right

If you added code using directly the shortcode and not the TinyMCE option, make sure you wrapped your code into a <pre></pre> element like in the example above.

I’m trying to add HTML and it’s not working

HTML code snippets can be added via the TinyMCE option, if you want to use the shortcode to display HTML content you’ll need to escape the HTML content before adding it into the shortcode.

Beoordelingen

4 juli 2021
Very nice plugin! Clean and fast. The only issue i have is that if you set slim="no", the first line of code disappears half way under the top border, so most likely need a bit of padding added. Other than that it great, Thanks a lot!
19 augustus 2020
This is what I had been looking for. It's beautiful and simple. I wish there was a way make it show as a regular Gutenberg block, I also wish there was a way to limit the height of the snippet. For example many of my snippets are just one line, but the snippet takes up to 4 lines, it would be nice if one could control the height so things would look a little slicker. Other than that awesome plugin, no problems with it so far. Keep up the good work.
23 maart 2019
After spending the last couple of days looking for a plugin to give some style to my code snippets (basically CSS, PHP, and Javascript), this is the only one that worked just fine with ThriveArchitect (and I likely tested all of the 'highlight' plugins from the repository.) Simple, lightweight, great dark theme, works with a short-code and includes a 'copy to clipboard' button. If anything, I'd ask to be able to customize the text strings from the events 'on success copy' and 'on error' without having to mess with js files (maybe with a couple of extra parameters in the short-code.) Keep up the good work!
Lees alle 3 beoordelingen

Bijdragers & ontwikkelaars

“Code Snippet DM” is open source software. De volgende personen hebben bijgedragen aan deze plugin.

Bijdragers

Vertaal “Code Snippet DM” naar jouw taal.

Interesse in ontwikkeling?

Bekijk de code, haal de SVN repository op, of abonneer je op het ontwikkellog via RSS.

Changelog

1.1

  • Added option to customize the Copy button text and also the confirmation text after you click it.
  • Fixed small content alignment issue.

1.2

  • Added support for shortcodes inside the [dm_code_snippet][your-shortcode][\dm_code_snippet].

1.3

  • Added support for Ruby and Python.
  • Added slim option that can be user for one-line code examples
  • Fixed overall spacing issue

1.3.1

  • Added support for Perl, SQL and TypeScript.
  • Fixed margin issue where it might break the page layout and align the code element to the left

1.3.2

  • Added support for ‘height’, allowing to set a max-height for the code snippet element.