Help Center Article Editor needs to support (easy) source code formatting

64 Comments

  • Arnor

    I agree 110%  I really liked that option in the old one as I have posted several articles with source code on my portal.  

    Arnor Baldvinsson - Icetips Alta LLC

    1
  • Matthew Marichiaba

    Markdown support, please!

    2
  • Diana Langston

    what are the editor options? right now, what i see seems super limited and is frustrating for content professionals trying to use Zendesk. Any other options to upgrade the editor, markdown, or a better html editor?

    0
  • Diana Langston

    Also, is there going to be a way to install some sort of plug-in for code examples, such as Prettify etc. 

    We need something that allows syntax highlighting of source code snippets.

    2
  • Wes Drury

    @Diana - Yes you can use JQuery plugins for this.  I've installed a few.

     

    0
  • Diana Langston

    @Wes - Thank you!!! 

    I can't wait to implement syntax highlighting. 

    0
  • Wes Drury

    @Diana - Glad I could help and let us know how it goes and what plugin you decided to go with.

    0
  • Arnor

    Hi Wes,

    Looking at the instructions:  " Click 'Customize design' then 'edit theme'. You will see a workspace with tabs on top load up."  I cannot find a "edit theme".  What am I missing?

    Best regards

    0
  • Wes Drury

    Hi Arnor - I think you posted this to the wrong article however I will provide you an answer here.  What plan are you on as you can't customize themes if you are on the Starter Plan.

    0
  • Anton Maslov

    @Wes - could you please plugin examples? What do you use to be able to use code blocks.

    0
  • Wes Drury

     @Anton - There are a few plugins out there like Highlight.js and Prism that should work however I normally use the embed from GitHub or Gist.

    You can see an example here.

    0
  • Tom

    Adding our vote for source code formatting in the Help Center article editor. The exact features we are looking for were written by Christian Colding of Zendesk here: https://support.zendesk.com/hc/en-us/community/posts/222554808/comments/249098547

    TinyMCE now has an excellent official 'Code Sample' plugin:  https://www.tinymce.com/docs/plugins/codesample/ It would be wonderful if this could be added to the Help Center editor. Please :-)

     

    7
  • Niclas Kårlin

    I works very well in tickets. Frustrating that those are not available in Article.

    1
  • Ryan McGrew

    Hi All,

    I appreciate the feedback. We've gotten a number of requests around code formatting for the Article Editor. I've recently taken over the Article Editor and I've tried to prioritize small scale improvements to the Editor every quarter. For example, we just released Headings and Video Embedding for videos. I will take this request around code formatting into account as we continue to make improvements in the coming quarters. The next feature we have in the queue for implementation of the editor is linking between articles. I don't have a timeline for when we'll get to this feature yet but we are looking to make overall improvements every quarter.

    Thanks!

    0
  • Jonathan March

    Thanks, Ryan. There are numerous requests for anchors scattered around the Community.

    0
  • Ryan McGrew

    Hi All,

    I realized I made an off topic statement here. In responding to a different post I forgot to update the content to reflect the content of this topic.

    Thanks!

    0
  • Rom Hirsh

    Hi Ryan,

     

    you can see the solution that Tom offered 

    "TinyMCE now has an excellent official 'Code Sample' plugin:  https://www.tinymce.com/docs/plugins/codesample/ It would be wonderful if this could be added to the Help Center editor. Please :-)"

     

    this seems like a simple implementation that should not span over "quarters" as you suggested. This is blocking our development of the HC and forcing us to look else were for documentation purposes. 

    1
  • Ryan McGrew

    Hey @Rom,

    You're right that improvements such as code formatting are typically smaller than other features we build and release. However, we have a number of priorities in a given quarter and have specific things that we need to deliver on for our customers and Zendesk as a business. I'm trying to prioritize some of these editor of features as we work on other things to keep pace with requests from our customers. So I will take your request under advisement, but I can't promise a given timeframe because I don't have the resources to deliver on it right now.

    Thanks!

    0
  • Niclas Kårlin

    Also please add a full editor to the Category and Section editors, and allow HTML.

     

    I created a new request.

    0
  • Maria McDowell

    +1

    The lack of code snippets is a major factor in our hesitancy to use Guide. Please add them!

    2
  • Nicole - Community Manager

    Hey Maria and Niclas - 

    We appreciate your feedback. Please be sure that you've used the voting buttons on the original post - those votes do count! 

    As Ryan indicated a couple of weeks ago, this functionality is on the radar, though there are no immediate plans to implement it as there are other developments that have taken priority at this time. But, we will keep this thread open and will continue to accept feedback on it. 

    0
  • Chun Lee

    Please please please prioritise this. This is not the only thread or request on this subject.

    1
  • Manuel Morales

    +1 

    There is no workaround that will work in my environment so we are waiting for this feature to be implemented ASAP.

    2
  • Larry Garfield

    I'm currently evaluating ZenDesk Guide as a knowledge base for our company, for potentially both internal and external docs.  The lack of a code sample formatting option could very well be a deal-breaker, as we have a LOT of code samples and command line examples in our current documentation.  Our target audience is developers so they'll want code samples.

    4
  • Jukka Raanamo

    Was also thinking of migrating to Zendesk Guide and put ALL documentation there but as technical company there's plenty of code in multiple languages we need to present to our users. If we cannot do that then we're better off with our current do-it-yourself documentation platform and using the rest of the Zendesk products also make little sense.

    2
  • Chaz Spahn

    +1 for Code Samples. This will be a great first step. But what we really need is custom style creation and selection. I have a need for Notes, Warning, Error, and Code. At this point, we are stating to look at other options for our KB because it is far to costly (time and resource wise) to get our articles they way we want them.

    NOTE: I have posted the same request for at least 5 different threads that all ask for this capability now.

    2
  • Nicole - Community Manager

    Hi Chaz - 

    Thank you for sharing your feedback here. I've catalogued all of the threads on this topic and passed that along to the Product teams, and we'll be working toward closing the other threads down and pointing them all to this one. 

    0
  • Pete Holborow

    Adding my voice for code samples as a requirement. You do it in the ticket editor, why not in the Guide editor?

    2
  • Eitan Blumin

    Adding my vote as well.

    This is such a common functionality, especially for something that's supposed to be a Knowledge Base...

    How do you not have this yet???

    1
  • George Mabey

    👋very much in favour of an improved code sample experience!

    1

Please sign in to leave a comment.

Powered by Zendesk