CINXE.COM
Get Help | Asciidoctor Docs
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width,initial-scale=1"> <title>Get Help | Asciidoctor Docs</title> <link rel="stylesheet" href="../../_/css/site.css"> <meta name="generator" content="Antora 3.1.8"> <link rel="canonical" href="https://docs.asciidoctor.org/about/get-help/"> <meta property="og:url" content="https://docs.asciidoctor.org/about/get-help/"> <meta property="og:description" content="A documentation page for Community."> <meta property="og:site_name" content="Asciidoctor Docs"> <meta name="twitter:card" content="summary_large_image"> <meta property="og:title" content="Community - Get Help"> <meta property="og:image" content="https://docs.asciidoctor.org/_/img/asciidoctor-og.png"> <meta name="twitter:site" content="@asciidoctor"> <link rel="prev" href="../code-of-conduct/"> <link rel="next" href="../version-and-release-policies/"> <meta name="page-spec" content="about::get-help.adoc"> <link rel="icon" href="../../_/img/favicon.ico" type="image/x-icon"> </head> <body class="article"> <header class="header"> <nav class="navbar"> <div class="navbar-brand"> <a class="navbar-item logo" title="Asciidoctor" href="https://asciidoctor.org"><img src="../../_/img/asciidoctor-logo.svg" alt="Asciidoctor" width="48"></a> <a class="navbar-item title" href="https://docs.asciidoctor.org/">Asciidoctor Docs</a> <button class="navbar-burger" aria-controls="topbar-nav" aria-expanded="false" aria-label="Toggle main menu"> <span></span> <span></span> <span></span> </button> </div> <div id="topbar-nav" class="navbar-menu"> <div class="navbar-end"> <div class="navbar-item search hide-for-print"> <div id="search" class="field has-filter"> <input class="query" type="text" placeholder="Search the docs"> <label class="filter checkbox"> <input type="checkbox" data-facet-filter="component:about"> In this project </label> </div> </div> <div class="navbar-item has-dropdown is-hoverable"> <div class="navbar-link">AsciiDoc</div> <div class="navbar-dropdown"> <a class="navbar-item" href="../../asciidoc/latest/">Language</a> <a class="navbar-item" href="../../asciidoc/latest/syntax-quick-reference/">Syntax Quick Reference</a> </div> </div> <div class="navbar-item has-dropdown is-hoverable"> <div class="navbar-link">Processing</div> <div class="navbar-dropdown"> <a class="navbar-item" href="../../asciidoctor/latest/">Asciidoctor <small>Ruby</small></a> <a class="navbar-item" href="../../asciidoctor.js/latest/">Asciidoctor.js <small>JavaScript</small></a> <a class="navbar-item" href="../../asciidoctorj/latest/">AsciidoctorJ <small>Java</small></a> </div> </div> <div class="navbar-item has-dropdown is-hoverable"> <div class="navbar-link">Extensions</div> <div class="navbar-dropdown"> <div class="navbar-item">Add-on Converters</div> <a class="navbar-item" href="../../pdf-converter/latest/">PDF <small>Ruby</small></a> <a class="navbar-item" href="../../epub3-converter/latest/">EPUB3 <small>Ruby</small></a> <a class="navbar-item" href="../../reveal.js-converter/latest/">reveal.js <small>Ruby, JavaScript</small></a> <hr class="navbar-divider"> <div class="navbar-item">Extended Syntax</div> <a class="navbar-item" href="../../diagram-extension/latest/">Asciidoctor Diagram <small>Ruby</small></a> </div> </div> <div class="navbar-item has-dropdown is-hoverable"> <div class="navbar-link">Tooling</div> <div class="navbar-dropdown is-right"> <div class="navbar-item">Build Automation</div> <a class="navbar-item" href="../../maven-tools/latest/">Maven Tools <small>Java</small></a> <a class="navbar-item" href="../../gradle-plugin/latest/">Gradle Plugin <small>Java</small></a> <a class="navbar-item" href="../../asciidoclet/latest/">Asciidoclet <small>Java</small></a> <hr class="navbar-divider"> <div class="navbar-item">Text Editors / Viewers</div> <a class="navbar-item" href="../../browser-extension/">Browser Extension</a> <a class="navbar-item" href="https://intellij-asciidoc-plugin.ahus1.de/docs" target="_blank" rel="noopener">IntelliJ Plugin</a> </div> </div> <div class="navbar-item has-dropdown is-hoverable"> <a class="navbar-item" href="./" data-title="Support"> <span class="icon"><img src="../../_/img/octicons-24.svg#view-comment-discussion"></span> </a> <div class="navbar-dropdown is-right"> <a class="navbar-item has-icon" href="https://chat.asciidoctor.org" target="_blank" rel="noopener"> <span class="icon"><img src="../../_/img/octicons-16.svg#view-comment-discussion"></span> <span>Chat</span> </a> <!-- <a class="navbar-item has-icon" href="https://discuss.asciidoctor.org" target="_blank" rel="noopener"> <span class="icon"><img src="../../_/img/octicons-16.svg#view-mail"></span> <span>List</span> </a> --> <a class="navbar-item has-icon" href="https://github.com/asciidoctor" target="_blank" rel="noopener"> <span class="icon"><img src="../../_/img/octicons-16.svg#view-mark-github"></span> <span>Source</span> </a> <a class="navbar-item has-icon" href="https://twitter.com/asciidoctor" target="_blank" rel="noopener"> <span class="icon"><img src="../../_/img/octicons-16.svg#view-hash"></span> <span>Tweets</span> </a> </div> </div> </div> </div> </nav> </header> <div class="body"> <div class="nav-container"> <aside class="nav"> <div class="panels"> <div class="nav-panel-menu is-active is-loading" data-panel="menu"> <nav class="nav-menu"> <button class="nav-menu-toggle" aria-label="Toggle expand/collapse all" style="display: none"></button> <h3 class="title"><a href="../">Community</a></h3> <ul class="nav-list"> <li class="nav-item" data-depth="0"> <ul class="nav-list"> <li class="nav-item" data-depth="1"> <a class="nav-link" href="../code-of-conduct/">Code of Conduct</a> </li> <li class="nav-item is-current-url" data-depth="1"> <a class="nav-link" href="./">Get Help</a> </li> <li class="nav-item" data-depth="1"> <a class="nav-link" href="../version-and-release-policies/">Version and Release Policies</a> </li> <li class="nav-item" data-depth="1"> <a class="nav-link" href="../history/">History</a> </li> </ul> </li> </ul> </nav> <script> ;(function () { var panel = document.querySelector('.nav-panel-menu') var page var hash = window.location.hash if (hash) { if (~hash.indexOf('%')) hash = decodeURIComponent(hash) if (~hash.indexOf('"')) hash = hash.replace(/(?=")/g, '\\') var link = panel.querySelector('.nav-link[href="' + hash + '"]') if (link) page = link.parentNode else if ((page = panel.querySelector('.is-current-url'))) page.classList.add('is-provisional') } else { page = panel.querySelector('.is-current-url') } if (page) { var ancestor = page while ((ancestor = ancestor.parentNode) && ancestor !== panel) { if (ancestor.className === 'nav-item') ancestor.classList.add('is-current-path', 'is-active') } page.classList.add('is-current-page', 'is-active') if (panel.scrollHeight > panel.clientHeight) { var panelRect = panel.getBoundingClientRect() var linkRect = page.querySelector('.nav-link').getBoundingClientRect() panel.scrollTop += Math.round(linkRect.top - panelRect.top - (panelRect.height - linkRect.height) * 0.5) } } else { panel.scrollTop = 0 } panel.classList.remove('is-loading') })() </script> </div> <div class="nav-panel-explore" data-panel="explore"> <div class="context"> <span class="title">Community</span> <span class="version"></span> </div> <ul class="components"> <li class="component"> <a class="title" href="../../asciidoc/latest/">AsciiDoc</a> </li> <li class="component"> <a class="title" href="../../asciidoctor/latest/">Asciidoctor</a> <ul class="versions"> <li class="version is-latest"> <a href="../../asciidoctor/latest/">2.0</a> </li> </ul> </li> <li class="component"> <a class="title" href="../../asciidoctor.js/latest/">Asciidoctor.js</a> <ul class="versions"> <li class="version is-latest"> <a href="../../asciidoctor.js/latest/">3.0</a> </li> <li class="version"> <a href="../../asciidoctor.js/2.2/">2.2</a> </li> </ul> </li> <li class="component"> <a class="title" href="../../asciidoctorj/latest/">AsciidoctorJ</a> <ul class="versions"> <li class="version is-latest"> <a href="../../asciidoctorj/latest/">3.0</a> </li> <li class="version"> <a href="../../asciidoctorj/2.5/">2.5</a> </li> </ul> </li> <li class="component"> <a class="title" href="../../pdf-converter/latest/">Asciidoctor PDF</a> <ul class="versions"> <li class="version is-latest"> <a href="../../pdf-converter/latest/">2.3</a> </li> <li class="version"> <a href="../../pdf-converter/2.2/">2.2</a> </li> <li class="version"> <a href="../../pdf-converter/2.1/">2.1</a> </li> <li class="version"> <a href="../../pdf-converter/2.0/">2.0</a> </li> </ul> </li> <li class="component"> <a class="title" href="../../epub3-converter/latest/">Asciidoctor EPUB3</a> <ul class="versions"> <li class="version is-latest"> <a href="../../epub3-converter/latest/">2.1</a> </li> </ul> </li> <li class="component"> <a class="title" href="../../reveal.js-converter/latest/">Asciidoctor reveal.js</a> <ul class="versions"> <li class="version is-latest"> <a href="../../reveal.js-converter/latest/">5.0</a> </li> <li class="version"> <a href="../../reveal.js-converter/4.1/">4.1</a> </li> </ul> </li> <li class="component"> <a class="title" href="../../maven-tools/latest/">Maven Tools</a> <ul class="versions"> <li class="version is-latest"> <a href="../../maven-tools/latest/">3.1</a> </li> <li class="version"> <a href="../../maven-tools/2.2/">2.2</a> </li> </ul> </li> <li class="component"> <a class="title" href="../../gradle-plugin/latest/">Gradle Plugin Suite</a> <ul class="versions"> <li class="version is-latest"> <a href="../../gradle-plugin/latest/">4.0</a> </li> </ul> </li> <li class="component"> <a class="title" href="../../asciidoclet/latest/">Asciidoclet</a> <ul class="versions"> <li class="version is-latest"> <a href="../../asciidoclet/latest/">2.0</a> </li> <li class="version"> <a href="../../asciidoclet/1.5.6/">1.5.6</a> </li> </ul> </li> <li class="component"> <a class="title" href="../../diagram-extension/latest/">Asciidoctor Diagram</a> <ul class="versions"> <li class="version is-latest"> <a href="../../diagram-extension/latest/">2.2</a> </li> </ul> </li> <li class="component"> <a class="title" href="../../browser-extension/">Browser Extension</a> </li> <li class="component is-current"> <a class="title" href="../">Community</a> </li> </ul> </div> </div> </aside> </div> <main class="article"> <div class="toolbar" role="navigation"> <button class="nav-toggle"></button> <a href="../../" class="home-link" title="Home"></a> <nav class="breadcrumbs" aria-label="breadcrumbs"> <ul> <li><a href="../">Community</a></li> <li><a href="./">Get Help</a></li> </ul> </nav> <div class="edit-this-page"><a href="https://github.com/asciidoctor/asciidoctor-community-docs/edit/main/about/modules/ROOT/pages/get-help.adoc">Edit this Page</a></div> </div> <div class="content"> <aside class="toc sidebar" data-title="Contents" data-levels="2"> <div class="toc-menu"></div> </aside> <article class="doc about"> <h1 class="page">Get Help</h1> <div id="preamble"> <div class="sectionbody"> <div class="paragraph"> <p>To be successful at writing and publishing AsciiDoc content with Asciidoctor, we encourage you to maintain a dialogue with the project maintainers and other community members. Don’t hesitate to ask questions and discuss any aspects of the project using an appropriate communication channel listed below. Your feedback helps drive the projects forward by providing use cases, ideas, metrics, and motivation.</p> </div> <div class="admonitionblock note"> <table> <tr> <td class="icon"> <i class="fa icon-note" title="Note"></i> </td> <td class="content"> Each project may provide more focused or preferred communication channels. Please refer to the help section for the respective project to find those details. </td> </tr> </table> </div> </div> </div> <div class="sect1"> <h2 id="chat"><a class="anchor" href="#chat"></a>Project chat</h2> <div class="sectionbody"> <div class="hdlist"> <table> <tr> <td class="hdlist1"> Platform </td> <td class="hdlist2"> <p>Zulip</p> </td> </tr> <tr> <td class="hdlist1"> URL </td> <td class="hdlist2"> <p><a href="https://chat.asciidoctor.org" class="bare">chat.asciidoctor.org</a></p> </td> </tr> </table> </div> <div class="paragraph"> <p><strong>The project chat is the preferred means of communication for all users of Asciidoctor.</strong> This policy helps keep the project sustainable. If you want to ask for help, share feedback, or exchange ideas with fellow community members in real time, please do so in the project chat.</p> </div> <div class="paragraph"> <p>The chat also serves as the project forum. Like a forum, the chat is partitioned into channels. If you find an ongoing discussion that matches the topic you’re interested in, feel free to join that discussion. Otherwise, please post a new topic in the <code>#users</code> channel (<strong>not</strong> the <code>#community</code> channel, please!) Please <strong>do not post</strong> unrelated questions or comments to an existing topic since that disrupts the discussion and makes answers more difficult to find.</p> </div> <div class="admonitionblock tip"> <table> <tr> <td class="icon"> <i class="fa icon-tip" title="Tip"></i> </td> <td class="content"> Please use the filter or search feature to find existing topics before starting a new one. </td> </tr> </table> </div> <div class="paragraph"> <p>If you’re starting a new topic that relates to a specific project, check if there’s a channel for that project and post to that channel instead of the <code>#users</code> channel. For example, if you want to ask a question that only applies to AsciidoctorJ, please create the topic in the <code>#users/asciidoctorj</code> channel.</p> </div> <div class="paragraph"> <p><strong>If you aren’t sure where to post, please post in the <code>#users</code> channel and a moderator will relocate the topic if necessary.</strong> No action is needed on your part.</p> </div> <div class="paragraph"> <p>The discussions in the project chat are archived and public. There’s no guarantee those logs will be saved indefinitely, though we plan keep them as long as we’re permitted to do so.</p> </div> <div class="paragraph"> <p>Keep in mind that people participate in the project chat voluntarily, so please be respectful of their time and interests. The project chat is not 1-on-1 support. You’re in a public space.</p> </div> <div class="paragraph"> <p>Do not <code>@</code> mention someone when writing a message unless a) the subject matter absolutely requires the attention of that person or b) that person has already replied to the topic and is interacting with you. Using the <code>@</code> mention to draw attention to your question is not courteous to that person or fair to others. You’re free to post your message to the community at large (no <code>@</code> mention). If someone has something to share in response, they will do so if and when they have time. You can reference someone without notifying them using the <code>@_</code> prefix, which is considered acceptable conduct.</p> </div> </div> </div> <div class="sect1"> <h2 id="issue-tracker"><a class="anchor" href="#issue-tracker"></a>Issue tracker</h2> <div class="sectionbody"> <div class="hdlist"> <table> <tr> <td class="hdlist1"> Platform </td> <td class="hdlist2"> <p>GitHub</p> </td> </tr> <tr> <td class="hdlist1"> URL </td> <td class="hdlist2"> <p><a href="https://github.com/asciidoctor/asciidoctor/issues" class="bare">github.com/asciidoctor/asciidoctor/issues</a></p> </td> </tr> </table> </div> <div class="admonitionblock important"> <table> <tr> <td class="icon"> <i class="fa icon-important" title="Important"></i> </td> <td class="content"> If the issue does not pertain to Asciidoctor core, please file the issue in the issue tracker for the relevant project. For example, to file an issue about AsciidoctorJ, please use the issue tracker at <a href="https://github.com/asciidoctor/asciidoctorj/issues" class="bare">github.com/asciidoctor/asciidoctorj/issues</a>. </td> </tr> </table> </div> <div class="paragraph"> <p>The issue tracker is the preferred channel for reporting verifiable bugs, regressions, and security vulnerabilities, or for making formal, specific, and well-defined change requests. <strong>Please do not ask questions about how to use the software in the issue tracker.</strong> The issue tracker is not a support portal. Instead, you may direct questions about usage to the <a href="#chat">project chat</a>. Please do not comment on closed issues unless you’re adding additional context, such as to report whether the fix worked for you or how you made use of it. If you post an unproductive comment on an open issue, such as “What’s the status of this issue after X years?”, your comment will be deleted.</p> </div> <div class="paragraph"> <p>Any significant change or decision about the project’s software is recorded in the issue tracker. The issue tracker is also used for planning releases via milestones and labels.</p> </div> </div> </div> <div class="sect1"> <h2 id="social-media"><a class="anchor" href="#social-media"></a>Social media</h2> <div class="sectionbody"> <div class="hdlist"> <table> <tr> <td class="hdlist1"> Platform </td> <td class="hdlist2"> <p>Twitter</p> </td> </tr> <tr> <td class="hdlist1"> URL </td> <td class="hdlist2"> <p><a href="https://twitter.com/asciidoctor" class="bare">twitter.com/asciidoctor</a></p> </td> </tr> </table> </div> <div class="paragraph"> <p>If you want to share your experience with Asciidoctor or help promote it, we encourage you to post about it on social media. When you post about Asciidoctor on Twitter, you can mention the official account for the project, <a href="https://twitter.com/asciidoctor">@asciidoctor</a>. You can also use the <a href="https://twitter.com/search?q=%23asciidoctor">#asciidoctor</a> hashtag to help others find your post or discover others who are talking about it.</p> </div> </div> </div> <div class="sect1"> <h2 id="discuss"><a class="anchor" href="#discuss"></a>Discussion list (archived)</h2> <div class="sectionbody"> <div class="hdlist"> <table> <tr> <td class="hdlist1"> Platform </td> <td class="hdlist2"> <p>Nabble</p> </td> </tr> <tr> <td class="hdlist1"> URL </td> <td class="hdlist2"> <p><a href="https://discuss.asciidoctor.org" class="bare">discuss.asciidoctor.org</a></p> </td> </tr> </table> </div> <div class="paragraph"> <p>In the past, this project used the discussion list for general communication. During that time, community members asked for help, shared feedback, and exchanged ideas with fellow community members over email. Since the successful introduction of the <a href="#chat">Project chat</a>, this channel of communication has been archived and is now read only. You may continue to use it as a knowledge base. However, all new questions, feedback, announcements, and other general discourse should be directed to the project chat.</p> </div> </div> </div> <div class="sect1"> <h2 id="please-be-considerate"><a class="anchor" href="#please-be-considerate"></a>Please be considerate</h2> <div class="sectionbody"> <div class="paragraph"> <p>Please understand that all members of this community are volunteers and support is provided to fellow community members at will and often out of personal interest. When using these communication channels, we expect you to uphold the <a href="../code-of-conduct/" class="xref page">Code of Conduct</a>.</p> </div> <div class="paragraph"> <p>If you’re seeking professional support, you can ask the project maintainers or other community members if they offer any services. Otherwise, keep in mind that people participating in this project do not work for you.</p> </div> </div> </div> <nav class="pagination"> <span class="prev"><a href="../code-of-conduct/">Code of Conduct</a></span> <span class="next"><a href="../version-and-release-policies/">Version and Release Policies</a></span> </nav> </article> </div> </main> </div> <footer class="footer"> <div class="footer-main"> <figure class="footer-brand"> <a class="logo" href="https://asciidoctor.org" target="_blank" rel="noopener"><img src="../../_/img/asciidoctor-logo.svg" alt="Asciidoctor" width="48"></a> <figcaption class="footer-brand-name"><a href="https://asciidoctor.org" target="_blank" rel="noopener">Asciidoctor</a></figcaption> </figure> <ul class="footer-brand-links"> <!-- <li><a href="https://asciidoctor.org" target="_blank" rel="noopener">Home</a></li> --> <li><a href="https://docs.asciidoctor.org">Docs</a></li> <li><a href="https://chat.asciidoctor.org" target="_blank" rel="noopener">Chat</a></li> <li><a href="https://github.com/asciidoctor" target="_blank" rel="noopener">Source</a></li> <li><a href="https://discuss.asciidoctor.org" target="_blank" rel="noopener">List (archive)</a></li> </ul> <p class="footer-brand-follow"> <a href="https://twitter.com/asciidoctor" title="Follow us on Twitter" target="_blank" rel="noopener"><img src="../../_/img/twitter-logo.svg" alt="Twitter logo" class="logo" width="28"><span class="handle">@asciidoctor</span></a> </p> </div> <div class="footer-legal"> <p>Copyright © 2024 Dan Allen, Sarah White, and individual Asciidoctor contributors. Except where noted, the content is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license.</p> <p>The <a href="https://github.com/asciidoctor/asciidoctor-docs-ui" target="_blank" rel="noopener">UI for this site</a> is derived from the Antora default UI and is licensed under the MPL-2.0 license. Several icons are imported from <a href="https://primer.style/octicons/" target="_blank" rel="noopener">Octicons</a> and are licensed under the MIT license.</p> <p>AsciiDoc® and AsciiDoc Language™ are trademarks of the Eclipse Foundation, Inc.</p> </div> <div class="footer-thanks"> <p>Thanks to our <a href="https://asciidoctor.org/supporters/" target="_blank" rel="noopener">backers</a> and <a href="https://asciidoctor.org/contributors/" target="_blank" rel="noopener">contributors</a> for helping to make this project possible. Additional thanks to:</p> <p class="badges"> <a href="https://opendevise.com" title="Development support by OpenDevise" target="_blank" rel="noopener"><img src="https://secure.gravatar.com/avatar/823717a797dbd78ceff7b26aa397f383.png?size=80" alt="OpenDevise Logo" width="30"></a> <a href="https://zulip.com" title="Chat powered by Zulip" target="_blank" rel="noopener"><img src="../../_/img/zulip-logo.svg" alt="Zulip logo" width="30"></a> <a href="https://algolia.com/docsearch" title="Search by Algolia DocSearch" target="_blank" rel="noopener"><img src="../../_/img/algolia-logo.svg" alt="Algolia logo" width="30"></a> <a href="https://netlify.com" title="Deploys by Netlify" target="_blank" rel="noopener"><img src="../../_/img/netlify-logo.svg" alt="Deploys by Netlify" width="67"></a> </p> <p>Authored in <a href="https://asciidoc.org" target="_blank" rel="noopener">AsciiDoc</a>.<br>Produced by <a href="https://antora.org" target="_blank" rel="noopener">Antora</a> and <a href="https://asciidoctor.org" target="_blank" rel="noopener">Asciidoctor</a>.</p> </div> </footer> <script id="site-script" src="../../_/js/site.js" data-ui-root-path="../../_"></script> <script async src="../../_/js/vendor/highlight.js"></script> <script async id="search-script" src="../../_/js/vendor/docsearch.js" data-app-id="V1SEVEBOXX" data-api-key="02ab3d2d0cab4dec119447e14abdd3bc" data-index-name="asciidoctor-docs" data-stylesheet="../../_/css/vendor/docsearch.css"></script> </body> </html>