-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapi.html
More file actions
31 lines (31 loc) · 24.7 KB
/
api.html
File metadata and controls
31 lines (31 loc) · 24.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
<!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-api docs-version-current docs-doc-page docs-doc-id-index" data-has-hydrated=false><head><meta charset=UTF-8><meta name=generator content="Docusaurus v3.10.0"><title data-rh=true>API | GraphQL-Markdown — GraphQL schema documentation generator</title><meta data-rh=true name=viewport content="width=device-width, initial-scale=1.0"/><meta data-rh=true property=og:image content=https://graphql-markdown.dev/img/social-card.jpg /><meta data-rh=true name=twitter:image content=https://graphql-markdown.dev/img/social-card.jpg /><meta data-rh=true property=og:url content=https://graphql-markdown.dev/api /><meta data-rh=true name=docusaurus_locale content=en /><meta data-rh=true name=docsearch:language content=en /><meta data-rh=true name=author content="Grégory Heitz"/><meta data-rh=true name=twitter:card content=summary_large_image /><meta data-rh=true name=twitter:title content=GraphQL-Markdown /><meta data-rh=true name=twitter:description content="Auto-generate beautiful Markdown and MDX docs from any GraphQL schema. Open-source CLI, Docusaurus integration, MIT licensed."/><meta data-rh=true property=og:type content=website /><meta data-rh=true property=og:site_name content=GraphQL-Markdown /><meta data-rh=true property=og:locale content=en_US /><meta data-rh=true name=docusaurus_version content=current /><meta data-rh=true name=docusaurus_tag content=docs-api-current /><meta data-rh=true name=docsearch:version content=current /><meta data-rh=true name=docsearch:docusaurus_tag content=docs-api-current /><meta data-rh=true name=robots content="noindex, nofollow"/><meta data-rh=true property=og:title content="API | GraphQL-Markdown — GraphQL schema documentation generator"/><meta data-rh=true name=description content="This section provides documentation of the GraphQL-Markdown API for NodeJS. For more details about each individual module, refer to the specific package documentation below."/><meta data-rh=true property=og:description content="This section provides documentation of the GraphQL-Markdown API for NodeJS. For more details about each individual module, refer to the specific package documentation below."/><link data-rh=true rel=icon href=/img/favicon.ico /><link data-rh=true rel=canonical href=https://graphql-markdown.dev/api /><link data-rh=true rel=alternate href=https://graphql-markdown.dev/api hreflang=en /><link data-rh=true rel=alternate href=https://graphql-markdown.dev/api hreflang=x-default /><script data-rh=true type=application/ld+json>{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","item":"https://graphql-markdown.dev/api/","name":"API","position":1}]}</script><script type=application/ld+json>{"@context":"https://schema.org","@type":"SoftwareApplication","applicationCategory":"DeveloperApplication","applicationSubCategory":"DocumentationTool","author":{"@type":"Person","name":"Grégory Heitz"},"codeRepository":"https://github.com/graphql-markdown/graphql-markdown","description":"Generate customizable Markdown/MDX documentation from GraphQL schemas. Works with Docusaurus and popular MDX frameworks.","downloadUrl":"https://www.npmjs.com/package/@graphql-markdown/cli","license":"https://opensource.org/licenses/MIT","name":"GraphQL-Markdown","offers":{"@type":"Offer","price":"0","priceCurrency":"USD"},"operatingSystem":"Linux, macOS, Windows","programmingLanguage":["TypeScript","JavaScript"],"softwareVersion":"latest","url":"https://graphql-markdown.dev"}</script><script type=application/ld+json>{"@context":"https://schema.org","@type":"FAQPage","mainEntity":[{"@type":"Question","acceptedAnswer":{"@type":"Answer","text":"GraphQL-Markdown is an open-source command-line tool and JavaScript/TypeScript library that auto-generates human-friendly Markdown and MDX documentation from any GraphQL schema. It supports Docusaurus out of the box and works with any MDX framework."},"name":"What is GraphQL-Markdown?"},{"@type":"Question","acceptedAnswer":{"@type":"Answer","text":"Yes. GraphQL-Markdown reads schemas from SDL files, introspection endpoints, or GraphQL config, so it works with Apollo Server, Hasura, GraphQL Yoga, and any server that exposes a standard GraphQL schema."},"name":"Does GraphQL-Markdown work with Apollo, Hasura, or custom GraphQL servers?"},{"@type":"Question","acceptedAnswer":{"@type":"Answer","text":"Yes. You can document custom directives, group types by directive, and use directive metadata to drive deprecation notices, tags, access-control badges, and other custom sections in the generated output."},"name":"Can GraphQL-Markdown generate docs for custom directives?"},{"@type":"Question","acceptedAnswer":{"@type":"Answer","text":"SpectaQL and GraphDoc produce standalone HTML sites. GraphQL-Markdown produces Markdown/MDX files that you commit alongside your existing docs site, so you keep your theme, search, versioning, and navigation. It is ideal for teams already using Docusaurus, Astro, Next.js, or any MDX-based framework."},"name":"How is GraphQL-Markdown different from SpectaQL or GraphDoc?"},{"@type":"Question","acceptedAnswer":{"@type":"Answer","text":"Yes. GraphQL-Markdown is free and open-source under the MIT license. If you use it in production, consider planting a tree via the Treeware initiative to support the project."},"name":"Is GraphQL-Markdown free to use?"}]}</script><link rel=manifest href=/manifest.json><meta name=theme-color content=#485e58><link rel=apple-touch-icon href=/img/graphql-markdown.png><link rel=stylesheet href=/assets/css/styles.83bc7c92.css /><script src=/assets/js/runtime~main.52ea6e7d.js defer></script><script src=/assets/js/main.fffe30dc.js defer></script></head><body><svg style="display: none;"><defs>
<symbol id=theme-svg-external-link viewBox="0 0 24 24"><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
</defs></svg>
<script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme-ac4")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||"light"),document.documentElement.setAttribute("data-theme-choice",t||"light")}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}(),document.documentElement.setAttribute("data-announcement-bar-initially-dismissed",function(){try{return"true"===localStorage.getItem("docusaurus.announcement.dismiss-ac4")}catch(t){}return!1}())</script><div id=__docusaurus><div role=region aria-label="Skip to main content"><a class=skipToContent_fXgn href=#__docusaurus_skipToContent_fallback>Skip to main content</a></div><div class="theme-announcement-bar announcementBar_mb4j" style=background-color:#485e58;color:#dbf5e6 role=banner><div class=announcementBarPlaceholder_vyr4></div><div class="content_knG7 announcementBarContent_xLdY">🚀 Now compatible with Astro, Next.js and more — see <a href=/docs/advanced/integration-with-frameworks>MDX framework integration</a> 🚀</div><button type=button aria-label=Close class="clean-btn close closeButton_CVFx announcementBarClose_gvF7"><svg viewBox="0 0 15 15" width=14 height=14><g stroke=currentColor stroke-width=3.1><path d="M.75.75l13.5 13.5M14.25.75L.75 14.25"/></g></svg></button></div><nav aria-label=Main class="theme-layout-navbar navbar navbar--fixed-top"><div class=navbar__inner><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded=false class="navbar__toggle clean-btn" type=button><svg width=30 height=30 viewBox="0 0 30 30" aria-hidden=true><path stroke=currentColor stroke-linecap=round stroke-miterlimit=10 stroke-width=2 d="M4 7h22M4 15h22M4 23h22"/></svg></button><a class=navbar__brand href=/><div class=navbar__logo><img src=/img/graphql-markdown.svg alt=GraphQL-Markdown class="themedComponent_mlkZ themedComponent--light_NVdE"/><img src=/img/graphql-markdown.svg alt=GraphQL-Markdown class="themedComponent_mlkZ themedComponent--dark_xIcU"/></div><b class="navbar__title text--truncate">GraphQL-Markdown</b></a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><a class="navbar__item navbar__link" href=/docs/intro>Docs</a><a aria-current=page class="navbar__item navbar__link navbar__link--active" href=/api>API</a><a class="navbar__item navbar__link" href=/showcase>Showcase</a><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href=# aria-haspopup=true aria-expanded=false role=button class=navbar__link>Examples</a><ul class=dropdown__menu><li><a class=dropdown__link href=/examples/default>Default</a><li><a class=dropdown__link href=/examples/group-by>Group by directive</a></ul></div><a href=https://github.com/graphql-markdown/graphql-markdown/releases target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">Release notes</a><a href=https://github.com/graphql-markdown/graphql-markdown target=_blank rel="noopener noreferrer" class="navbar__item navbar__link header-github-link" aria-label="GitHub repository"></a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type=button disabled title="system mode" aria-label="Switch between dark and light mode (currently system mode)"><svg viewBox="0 0 24 24" width=24 height=24 aria-hidden=true class="toggleIcon_g3eP lightToggleIcon_pyhR"><path fill=currentColor d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"/></svg><svg viewBox="0 0 24 24" width=24 height=24 aria-hidden=true class="toggleIcon_g3eP darkToggleIcon_wfgR"><path fill=currentColor d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"/></svg><svg viewBox="0 0 24 24" width=24 height=24 aria-hidden=true class="toggleIcon_g3eP systemToggleIcon_QzmC"><path fill=currentColor d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"/></svg></button></div><div class=navbarSearchContainer_Bca1><div class=dsla-search-wrapper><div class=dsla-search-field data-tags=default,docs-default-current,docs-example-default-current,docs-example-group-by-current,docs-api-current></div></div></div></div></div><div role=presentation class=navbar-sidebar__backdrop></div></nav><div id=__docusaurus_skipToContent_fallback class="theme-layout-main main-wrapper mainWrapper_z2l0"><div class=docsWrapper_hBAB><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type=button></button><div class=docRoot_UBD9><aside class="theme-doc-sidebar-container docSidebarContainer_YfHR"><div class=sidebarViewport_aRkj><div class=sidebar_njMd><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG menuWithAnnouncementBar_GW3s"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link menu__link--active" aria-current=page href=/api><span title=API class=linkLabel_WmDU>API</span></a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist" href=/api/category/graphql-markdowncli><span title=@graphql-markdown/cli class=categoryLinkLabel_W154>@graphql-markdown/cli</span></a><button aria-label="Expand sidebar category '@graphql-markdown/cli'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist" href=/api/category/graphql-markdowncore><span title=@graphql-markdown/core class=categoryLinkLabel_W154>@graphql-markdown/core</span></a><button aria-label="Expand sidebar category '@graphql-markdown/core'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/api/diff><span title=diff class=linkLabel_WmDU>diff</span></a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist" href=/api/category/graphql-markdowndocusaurus><span title=@graphql-markdown/docusaurus class=categoryLinkLabel_W154>@graphql-markdown/docusaurus</span></a><button aria-label="Expand sidebar category '@graphql-markdown/docusaurus'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist" href=/api/category/graphql-markdowngraphql><span title=@graphql-markdown/graphql class=categoryLinkLabel_W154>@graphql-markdown/graphql</span></a><button aria-label="Expand sidebar category '@graphql-markdown/graphql'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist" href=/api/category/graphql-markdownhelpers><span title=@graphql-markdown/helpers class=categoryLinkLabel_W154>@graphql-markdown/helpers</span></a><button aria-label="Expand sidebar category '@graphql-markdown/helpers'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/api/logger><span title=logger class=linkLabel_WmDU>logger</span></a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist" href=/api/category/graphql-markdownprinter-legacy><span title=@graphql-markdown/printer-legacy class=categoryLinkLabel_W154>@graphql-markdown/printer-legacy</span></a><button aria-label="Expand sidebar category '@graphql-markdown/printer-legacy'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist" href=/api/category/graphql-markdownutils><span title=@graphql-markdown/utils class=categoryLinkLabel_W154>@graphql-markdown/utils</span></a><button aria-label="Expand sidebar category '@graphql-markdown/utils'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div></ul></nav></div></div></aside><main class=docMainContainer_TBSr><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_VOVn"><div class=docItemContainer_Djhp><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label=Breadcrumbs><ul class=breadcrumbs><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_YNFT><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link>API</span></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type=button class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>API</h1></header>
<p>This section provides documentation of the GraphQL-Markdown API for NodeJS. For more details about each individual module, refer to the specific package documentation below.</p>
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id=packages>Packages<a href=#packages class=hash-link aria-label="Direct link to Packages" title="Direct link to Packages" translate=no></a></h2>
<p>GraphQL-Markdown is organized into several packages:</p>
<ul>
<li class=""><a class="" href=/api/category/graphql-markdowncli>@graphql-markdown/cli</a> - Command-line interface for generating documentation</li>
<li class=""><a class="" href=/api/category/graphql-markdowncore>@graphql-markdown/core</a> - Core functionality and base classes</li>
<li class=""><a class="" href=/api/category/graphql-markdowndocusaurus>@graphql-markdown/docusaurus</a> - Docusaurus plugin and MDX formatters</li>
<li class=""><a class="" href=/api/category/graphql-markdowngraphql>@graphql-markdown/graphql</a> - GraphQL schema utilities and helpers</li>
<li class=""><a class="" href=/api/category/graphql-markdownhelpers>@graphql-markdown/helpers</a> - Helper functions for documentation generation</li>
<li class=""><a class="" href=/api/category/graphql-markdownprinter-legacy>@graphql-markdown/printer-legacy</a> - Legacy markdown printer implementation</li>
<li class=""><a class="" href=/api/category/graphql-markdownutils>@graphql-markdown/utils</a> - Utility functions and helpers</li>
</ul>
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id=installation>Installation<a href=#installation class=hash-link aria-label="Direct link to Installation" title="Direct link to Installation" translate=no></a></h2>
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">npm install @graphql-markdown/cli</span><br/></div><div class=token-line style=color:#393A34><span class="token plain"># or with your preferred package manager</span><br/></div><div class=token-line style=color:#393A34><span class="token plain">yarn add @graphql-markdown/cli</span><br/></div></code></pre></div></div>
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id=basic-usage>Basic Usage<a href=#basic-usage class=hash-link aria-label="Direct link to Basic Usage" title="Direct link to Basic Usage" translate=no></a></h2>
<p>Using the CLI:</p>
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">graphql-markdown --schema ./schema.graphql --root ./docs</span><br/></div></code></pre></div></div>
<p>For programmatic usage, you can use the CLI package:</p>
<div class="language-typescript codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-typescript codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token keyword" style=color:#00009f>import</span><span class="token plain"> </span><span class="token punctuation" style=color:#393A34>{</span><span class="token plain"> runGraphQLMarkdown </span><span class="token punctuation" style=color:#393A34>}</span><span class="token plain"> </span><span class="token keyword" style=color:#00009f>from</span><span class="token plain"> </span><span class="token string" style=color:#e3116c>"@graphql-markdown/cli"</span><span class="token punctuation" style=color:#393A34>;</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain" style=display:inline-block></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"></span><span class="token keyword" style=color:#00009f>const</span><span class="token plain"> config </span><span class="token operator" style=color:#393A34>=</span><span class="token plain"> </span><span class="token punctuation" style=color:#393A34>{</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> schema</span><span class="token operator" style=color:#393A34>:</span><span class="token plain"> </span><span class="token string" style=color:#e3116c>"./schema.graphql"</span><span class="token punctuation" style=color:#393A34>,</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> rootPath</span><span class="token operator" style=color:#393A34>:</span><span class="token plain"> </span><span class="token string" style=color:#e3116c>"./docs"</span><span class="token punctuation" style=color:#393A34>,</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"></span><span class="token punctuation" style=color:#393A34>}</span><span class="token punctuation" style=color:#393A34>;</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain" style=display:inline-block></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"></span><span class="token keyword" style=color:#00009f>await</span><span class="token plain"> </span><span class="token function" style=color:#d73a49>runGraphQLMarkdown</span><span class="token punctuation" style=color:#393A34>(</span><span class="token plain">config</span><span class="token punctuation" style=color:#393A34>)</span><span class="token punctuation" style=color:#393A34>;</span><br/></div></code></pre></div></div>
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id=contributing>Contributing<a href=#contributing class=hash-link aria-label="Direct link to Contributing" title="Direct link to Contributing" translate=no></a></h2>
<p>This documentation is intended primarily for those interested in:</p>
<ul>
<li class="">Contributing to the GraphQL-Markdown codebase</li>
<li class="">Developing custom documentation generators</li>
<li class="">Extending the base functionality</li>
<li class="">Understanding the internal architecture</li>
</ul></div></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href=#packages class="table-of-contents__link toc-highlight">Packages</a><li><a href=#installation class="table-of-contents__link toc-highlight">Installation</a><li><a href=#basic-usage class="table-of-contents__link toc-highlight">Basic Usage</a><li><a href=#contributing class="table-of-contents__link toc-highlight">Contributing</a></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2020-2026 Grégory Heitz. Built with Docusaurus.</div></div></div></footer></div></body>