Help Center Formatting

47 Comments

  • Tom
    Comment actions Permalink

    +100 for allowing easy editing of code samples - both inline and blocks - in the article editor. This would be a huge win for us.

    Heading levels instead of font size and quote formatting would be great too as described by Christian above.

    We like the stripped down editor and it keeps the HTML clean.

    Really hoping these features can be added soon :-)

     

    5
  • Joel Hellman
    Comment actions Permalink

    For us, code blocks is without a doubt what we miss the most right now. If possible, being able to use tab to indent when editing in side a code block would be a very nice feature, though more a nice to have. 

    Quote is much needed in comments editor (and we do want it in the article editor as well, though much less).

    We like to have inline code in the article editor as well in addition to code blocks, to us if we have to choose (for whatever reason), we'd rather have inline code in the article editor, but I don't see why not in both. 

    Better shortcuts for the article editor headings (which would be nice to have as proper headings as you say, for compability with other systems) would be nice. Like ctrl-1 for h1 (biggest), ctrl-2 for h2 (big)..., and ctrl-0 for normal. 

    Some other things we'd like in the editor formattning-wise

    A keyboard shortcut list for the article editor like we have in Zendesk support, where you can lookup the keyboard shortcuts, would be nice.

    Basic template blocks like info/tip/warning etc (kind of how confluence or screensteps etc have) that helps make articles more digestable would be a nice addition.

    Support for collapsible sections like Confluence Expand macro or Screensteps would be also be very nice, so we can keep longer guide-style articles compact and more digestable.

    By the way, awesome improvement that we can now copy-paste images into the article editor - we love that  :)

     

    3
  • Bevans
    Comment actions Permalink

    I can't believe this is still a thing. I started moaning about this years ago, long before I opened this post.

    We're lucky enough to have grown enough to develop our way out of this. And you, Zendesk, are lucky enough that I cannot be bothered to vote with my feet and seek another provider. We're too busy, too much interruption to the business. You've got us by the proverbials. I suspect there are many looking at this thread lean enough to ditch you without thinking twice.

    this is SO BLOODY SIMPLE. It's such a simple ask and one that still, after all this time, has no resolution. You need to wake up to these things or someone is going to come along and gobble all of the HUNDREDS - maybe THOUSANDS of technical startups that would benefit IMMENSELY from something so SIMPLE. When we signed up for our trial, we could do this. When we signed on the dotted line, it was gone. Many years later, it's still BROKEN. 

    WAKE UP

     

    3
  • Bevans
    Comment actions Permalink

    Woke up still fuming about this. 

    YOU EVEN HAVE THE CODE PARAGRAPH HERE - WHAT IS THE PROBLEM?!?!

    From Elizabeth back in September:

    "I'm sorry that it's disappointing and that we don't have a better workaround. Our product development teams have to balance their priorities based on a variety of factors, and at the moment there are simply other things that have to be a higher priority for them. We wish we could build everything that everyone asks for, but we get hundreds of feature requests every month and they have to be prioritized. "

    This a NOT A FEATURE REQUEST. You wouldn't be adding a feature. It's a SUPPORT REQUEST. Help Centre, or Guide, or Super Awesome Unicorn Wiki or whatever you're calling it today is BROKEN and you need to prioritize FIXING IT.

    I circle back to our trial when we evaluated Zendesk. We had this functionality. We buy the product and WOOSH! It's gone.

    It's costs me FIVE FIGURE yearly sums that I have had to invest into other products SIMPLY BECAUSE:

    YOU CANNOT DO CODE BLOCKS

    Oh! But Wait! you can do code blocks!! Just not in the place where PEOPLE NEED IT THE MOST.

    You REALLY NEED TO WAKE UP TO HOW DISRUPTIVE THIS IS FOR MANY, MANY, MANY PEOPLE.

     

     

    3
  • Ryan McGrew
    Comment actions Permalink

    Hey all,

    Today we've rolled out an ability to insert code blocks as pre-formatted text in the article editor. It's a small change and doesn't include syntax highlighting, but will hopefully will make it a little easier to insert code into your articles.

    We will continue to take more advanced functionality as a product feedback.

    Thanks!

    3
  • Christian Colding
    Comment actions Permalink

    Hi Bevans,

    First off, we have two different editors depending on whether it's for articles or for Community comments.

    For the article editor, and comparing that to the ticket editor, you would want these features:

    • Headings instead of sizes
    • Quote
    • Code - both inline and as blocks

    For the Community editor, you would want these features:

    • Quote
    • Code - Inline

    Is that correct? How would you expect to use each of these features? I'm looking for examples of how the styling would apply in your case, so we can understand what problems it would solve to add the new stylings.

    Thank you.

    2
  • Tom
    Comment actions Permalink
    You're using a stripped down TinyMCE editor which I like. TinyMCE has a new excellent official code sample plugin.
     
     
    The menu item looks like this: Inline image 1
     
    Give it a try - it's excellent and it offers syntax highlighting via prism.js
     
    It would be a relatively small amount of developer time to implement this on Zendesk Help Center and would be a huge win for Zendesk customers writing articles with code samples.
     
    (There are a number of feature requests on these forums for this feature but most refer to the old less stripped down version of the editor.)
    2
  • Vinicius Souza
    Comment actions Permalink

    has not yet been implemented?

    2
  • Fabien RIC
    Comment actions Permalink

    Hi,

    For those looking for a way to integrate code syntax highlighting in Zendesk, here is how I did.

    I use highlight.js (https://highlightjs.org), which is powerful and quite easy to integrate in Zendesk. This is a javascript library and CSS which will auto-detect code in your page and syntax highlight it. It comes with support for tons of languages and color styles.

    Here are the steps to follow:

    • Add highlight.js JS and CSS files in your document_head.hbs theme file like this (feel free to change the style to suit your needs) :
    {{!-- highlight.js integration for code blocks --}}
    <link rel="stylesheet"
    href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/styles/atom-one-dark.min.css">
    <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/highlight.min.js"></script>
    • You then have to call highlight.js on every piece of code you may have in your article. To make things simple, I call it on all <pre> elements. To do that, modify the script.js file of your theme by adding the highlight.js call at the end:
    $(document).ready(function() {

    existing stuff...

    //Highlight code in <pre> tags created with the content editor
    $('pre').each(function(i, block) {
    hljs.highlightBlock(block);
    });
    });
    • Finally, to make sure the highlight.js styling is correctly applied, modify your style.css theme file as follow, to remove the default CSS on the <code> and <pre> elements. I kept the default style on <pre class="nohlghlight">, which enables to have regular <pre> blocks (without syntax highlighting) if needed.
    /* Disabled as we use highlight.js for code highlighting

    .article-body code {
    background: darken($background_color, 3%);
    border: 1px solid #ddd;
    border-radius: 3px;
    padding: 0 5px;
    margin: 0 2px;
    }
    */

    /* nohighlight only */
    .article-body pre.nohighlight {
    background: darken($background_color, 3%);
    border: 1px solid #ddd;
    border-radius: 3px;
    padding: 10px 15px;
    overflow: auto;
    white-space: pre;
    }

    That's it for the integration, now if you want to add a code block to an article :

    1. Go in the article editor and create a code block (which is a <pre> tag)
    2. Paste some code inside
    3. Save the article and preview it :)

    Highlight.js tries to detect the language used in the block ; however you can set the language directly by going in the HTML source of your article in the editor and set the class as follow: <pre class="java"> for example.

    I recommend having a look at the following page if needed: https://highlightjs.org/usage/

    Hope it's helpful for other tech companies working with Zendesk.

     

     

     

     

     

    2
  • Christian Colding
    Comment actions Permalink

    Hi Bevans,

    We are indeed looking into how we can improve the editor. One of the things we are looking at is the ability to do code blocks.

    Are there other features that you want to do besides code blocks?

    1
  • Mike
    Comment actions Permalink

    +1

    OP nailed it with "confluence-style editing capabilities".

    What I'm most frustrated by are:

    • Huge PITA when trying to format/justify text in lists. The editor goes nuts sometimes and appears to have a mind of its own when modifying indentation of listed items
    • Image layout. We are a mobile app, when we want to include screenshots, we end up with tons of whitespace due to inability to effectively position images around text blocks and vice versa.
    1
  • Clayton Rogers
    Comment actions Permalink

    The ability to add code snippets is vital. For companies providing support via their community, customers and agents need the ability to paste code into their comments in order to facilitate troubleshooting, communication, and the list goes on and on. 

    1
  • Nicole - Community Manager
    Comment actions Permalink

    Hey Chun - 

    I'm sorry that it's disappointing and that we don't have a better workaround. Our product development teams have to balance their priorities based on a variety of factors, and at the moment there are simply other things that have to be a higher priority for them. We wish we could build everything that everyone asks for, but we get hundreds of feature requests every month and they have to be prioritized. 

    1
  • Matt Bailey
    Comment actions Permalink

    We need to be able to put blocks of code with syntax highlighting in our HC docs. How on earth, in 2017, is this not possible?!... I can't even embed a Github gist as script tags are stripped out when the page is published. All we get is an ugly grey <pre> block. Simply not good enough...

    1
  • Tom
    Comment actions Permalink

    Nicole - if you can raise this with the product team it would be great. I linked to the TinyMCE 'codesample' plugin back in January (see above) and Matt has just re-linked to it. It's an official part of TinyMCE and you use TinyMCE as the editor. Including this cannot be hard for your developers and would be a huge win for customers using Guide / Help Center.

    To reiterate - you won't need to write any code to support this. Just integrate the official TinyMCE plugin.

    Come on Zendesk you can do it!

    1
  • Pete Holborow
    Comment actions Permalink

    Just adding my voice to this - we need code editing functionality in Guide.

    1
  • Carsten Falborg
    Comment actions Permalink

    Hi Bevans

    I know there is a lot of work going on with the HelpCenter, so perhaps Christian the PM from the HC team can answer that more accurately? 

    0
  • Bevans
    Comment actions Permalink

    Yeah there's loads you can do to improve the editor, but it's so completely stripped down that I'd just take code blocks and be happy with that at this point.

     Anything I can do in a ticket - and I can make those tickets absolutely sing in my customer responses - I should be able to do in help centre. That would be a significant leap ahead. Where we are at now I can't move forward with our knowledge base unless I hire a team of web devs to do the boring tasks of converting our internal docs. I dare not enable the community features if I cannot answer them in the same way I can from the agent interface. In either case we are losing money that in the year 2016 I can't believe we are losing - either through inefficient interaction with customers or by plowing money into web dev. 

    At the cost outlay for the Zendesk tier we are on, my expectation would be Confluence-style editing capabilities.

    Markdown would be amazing, but if I am totally honest I've given up holding my breath on that one.

    But yeah - let's start with the code blocks.

    0
  • Christian Colding
    Comment actions Permalink

    Thank you Joel for pitching in with some feedback here. All of this is something we'll take into consideration as we consider where to take our editor.

    0
  • Tom
    Comment actions Permalink

    Just edited my post above as I had the wrong link to the code sample plugin. It's here: https://www.tinymce.com/docs/plugins/codesample/

    0
  • Graeme Carmichael
    Comment actions Permalink

    Mike

    This is probably, not a great suggestion or best practice. But you can insert a table, place your image into a table cell and then some text on the adjacent cell. That way you can (kind of) align images and text. Might help in some instances.

    0
  • Chun Lee
    Comment actions Permalink

    Please can we have an update on this, 8 months since you let us know what Zendesk would like to do but no information on the current time line

    0
  • Nicole - Community Manager
    Comment actions Permalink

    Hey Chun - 

    I'll check in with our Product Managers to see if this is still under consideration. It might take a day or two to get back to you, as the folks working on this stuff are a few time zones away. 

    0
  • Nicole - Community Manager
    Comment actions Permalink

    Hey all - 

    I heard back, and unfortunately the update is that this is not something that's currently prioritized on the roadmap. 

    However, they suggested linking to github gists for this purpose - several people here use that in order to provide code in our own community posts and say it works well. 

    Sorry I didn't have the answer you were looking for, but I hope this workaround helps!

    0
  • Chun Lee
    Comment actions Permalink

    Nicole,

    This is very disappointing, and the workaround will not work for us due to the nature of our clients generally black listing sites such as github and only white listing our domain. The snippit also shows github which is not the interface we wish to present to our clients see below

    I don't really understand why this cant be added to the roadmap when the code block functionality and others are already incorporated into the ticketing editor

    0
  • Nicole - Community Manager
    Comment actions Permalink

    Thanks for the feedback, Matt, and welcome to the Zendesk Community! I'm sorry that this isn't yet available. Our Product Development teams are constantly balancing many priorities and decisions. We'll keep you posted if and when this feature comes online. 

    0
  • Matt Bailey
    Comment actions Permalink

    TinyMCE codesample plugin. Job done.

    0
  • Nicole - Community Manager
    Comment actions Permalink

    Hey Tom - 

    Our official process for escalating things to the Product Team is to post feedback in the Product Feedback forum. They make a point of digging around in there on a weekly basis, so my best suggestion is to post there, detailing your use case and the impact that this has on your business/customers. PMs don't have time to respond to everything (we get hundreds of posts a month) but they do read it and take those posts into consideration when they're going through a planning and prioritization process. 

     

    0
  • Nicole - Community Manager
    Comment actions Permalink

    Thanks, Tom. 

    0

Please sign in to leave a comment.

Powered by Zendesk