-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
1 lines (1 loc) · 13.7 KB
/
index.html
1
<!doctype html><html lang=en dir=ltr class="plugin-pages plugin-id-default" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.7.0"><title data-rh=true>GraphQL-Markdown | GraphQL-Markdown</title><meta data-rh=true name=viewport content="width=device-width, initial-scale=1.0"><meta data-rh=true name=twitter:card content=summary_large_image><meta data-rh=true property=og:url content=https://graphql-markdown.dev/><meta data-rh=true property=og:locale content=en><meta data-rh=true name=docusaurus_locale content=en><meta data-rh=true name=docusaurus_tag content=default><meta data-rh=true name=docsearch:language content=en><meta data-rh=true name=docsearch:docusaurus_tag content=default><meta data-rh=true property=og:title content="GraphQL-Markdown | GraphQL-Markdown"><meta data-rh=true name=description content="Human-friendly documentation for GraphQL schemas."><meta data-rh=true property=og:description content="Human-friendly documentation for GraphQL schemas."><link data-rh=true rel=icon href=/img/favicon.ico><link data-rh=true rel=canonical href=https://graphql-markdown.dev/><link data-rh=true rel=alternate href=https://graphql-markdown.dev/ hreflang=en><link data-rh=true rel=alternate href=https://graphql-markdown.dev/ hreflang=x-default><script data-rh=true>document.addEventListener("DOMContentLoaded",function(){void 0===window.docusaurus&&insertBanner()});function insertBanner(){var n=document.createElement("div");n.id="__docusaurus-base-url-issue-banner-container",n.innerHTML='\n<div id="__docusaurus-base-url-issue-banner" style="border: thick solid red; background-color: rgb(255, 230, 179); margin: 20px; padding: 20px; font-size: 20px;">\n <p style="font-weight: bold; font-size: 30px;">Your Docusaurus site did not load properly.</p>\n <p>A very common reason is a wrong site <a href="https://docusaurus.io/docs/docusaurus.config.js/#baseUrl" style="font-weight: bold;">baseUrl configuration</a>.</p>\n <p>Current configured baseUrl = <span style="font-weight: bold; color: red;">/</span> (default value)</p>\n <p>We suggest trying baseUrl = <span id="__docusaurus-base-url-issue-banner-suggestion-container" style="font-weight: bold; color: green;"></span></p>\n</div>\n',document.body.prepend(n);var e=document.getElementById("__docusaurus-base-url-issue-banner-suggestion-container"),s=window.location.pathname;e.innerHTML="/"===s.substr(-1)?s:s+"/"}</script><link rel=stylesheet href=/assets/css/styles.1274b3e7.css><script src=/assets/js/runtime~main.b2b864b2.js defer></script><script src=/assets/js/main.213ffe9c.js defer></script><body class=navigation-with-keyboard data-theme=light><script>!function(){var t,e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();t=null!==e?e:"light",document.documentElement.setAttribute("data-theme",t)}(),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")}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=announcementBar_mb4j style=background-color:#485e58;color:#dbf5e6 role=banner><div class=announcementBarPlaceholder_vyr4></div><div class="content_knG7 announcementBarContent_xLdY">🚀 Now compatible with AstroJS, NextJS and more... <a href=/docs/advanced/integration-with-frameworks>check our documentation</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="navbar navbar--fixed-top"><div class=navbar__inner><div class=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="navbar__items navbar__items--right"><a class="navbar__item navbar__link" href=/docs/intro>Docs</a><a class="navbar__item navbar__link" 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="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)" aria-live=polite aria-pressed=false><svg viewBox="0 0 24 24" width=24 height=24 class=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 class=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></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="main-wrapper mainWrapper_z2l0"><header class="hero hero--secondary heroBanner_qdFl"><div class=container><img class="hero heroImage_xZN7" src=/img/preview.svg alt=""><p class=hero__subtitle><span style=color:#36c46f>Flexible</span> documentation for<!-- --> <a target=_blank rel="noopener noreferrer" href=https://graphql.org/><span style=color:#e535ab>GraphQL</span></a> <!-- -->schemas.<p class=hero__subtitle>Powered by<!-- --> <a href=/docs/advanced/integration-with-frameworks><span style=color:#36c46f>[put your documentation generator here]</span></a>.<div class="margin-vert--lg buttons_AeoN"><a class="button button--primary button--lg margin-horiz--lg heroButton_GTT_" href=/docs/get-started>Get started</a><a class="button button--outline button--lg margin-horiz--lg heroButton_GTT_ heroButtonSecondary_bJri" href=/docs/try-it>Try it</a></div></div></header><main><section class=features_t9lD><div class=container><div class=column><div class="row margin-vert--lg padding-vert--lg feature_CLW0"><div class="col col--2 col--offset-2"><svg xmlns=http://www.w3.org/2000/svg xml:space=preserve viewBox="0 0 319.375 319.375" class=featureSvg_GfXr role=img><path d="M7.5 88.402h304.375v192.952H7.5z" style=fill:#fff /><path d="M7.5 38.021h304.375v50.381H7.5z" style=fill:#c7e9f4 /><path d="M36.354 170.688h104.667v87H36.354z" style=fill:#f59d00 /><path d="M165.021 170.688h118v32h-118zM165.021 225.688h118v32h-118z" style=fill:#ffda79 /><path d="M36.021 112.069h247v34.952h-247z" style=fill:#cbe5c0 /><path d="M311.875 30.521H7.5a7.5 7.5 0 0 0-7.5 7.5v243.333a7.5 7.5 0 0 0 7.5 7.5h304.375a7.5 7.5 0 0 0 7.5-7.5V38.021a7.5 7.5 0 0 0-7.5-7.5M15 45.521h289.375v35.381H15zm289.375 228.333H15V95.902h289.375z" style=fill:#13829b /><circle cx=36.021 cy=63.211 r=9 style=fill:#13829b /><circle cx=66.021 cy=63.211 r=9 style=fill:#13829b /><circle cx=96.021 cy=63.211 r=9 style=fill:#13829b /><path d="M141.02 163.188H36.354a7.5 7.5 0 0 0-7.5 7.5v87a7.5 7.5 0 0 0 7.5 7.5H141.02a7.5 7.5 0 0 0 7.5-7.5v-87c0-4.143-3.357-7.5-7.5-7.5m-7.5 87H43.854v-72h89.666zM283.021 163.188h-118a7.5 7.5 0 0 0-7.5 7.5v32a7.5 7.5 0 0 0 7.5 7.5h118a7.5 7.5 0 0 0 7.5-7.5v-32a7.5 7.5 0 0 0-7.5-7.5m-7.5 32h-103v-17h103zM283.021 218.188h-118a7.5 7.5 0 0 0-7.5 7.5v32a7.5 7.5 0 0 0 7.5 7.5h118a7.5 7.5 0 0 0 7.5-7.5v-32a7.5 7.5 0 0 0-7.5-7.5m-7.5 32h-103v-17h103zM36.021 154.521h247a7.5 7.5 0 0 0 7.5-7.5v-34.953a7.5 7.5 0 0 0-7.5-7.5h-247a7.5 7.5 0 0 0-7.5 7.5v34.953a7.5 7.5 0 0 0 7.5 7.5m7.5-34.953h232v19.953h-232z" style=fill:#13829b /></svg></div><div class="col col--6 col--offset-1"><div class=text--left><h3 class=padding-vert--md>Turn your schema into documentation</h3><p>GraphQL-Markdown is command line tool and JS/TS library for turning your GraphQL schemas into beautiful documentation without effort.</div></div></div><div class="row margin-vert--lg padding-vert--lg feature_CLW0"><div class="col col--2 col--offset-2"><svg xmlns=http://www.w3.org/2000/svg viewBox="0 0 24 24" class=featureSvg_GfXr role=img><title>MDX</title><path d="M.79 7.12h22.42c.436 0 .79.355.79.792v8.176a.79.79 0 0 1-.79.79H.79a.79.79 0 0 1-.79-.79V7.912a.79.79 0 0 1 .79-.791zm2.507 7.605v-3.122l1.89 1.89L7.12 11.56v3.122h1.055v-5.67l-2.99 2.99L2.24 9.056v5.67h1.055v-.001Zm8.44-1.845-1.474-1.473-.746.746 2.747 2.747 2.745-2.747-.746-.746-1.473 1.473v-4h-1.054v4Zm10.041.987-2.175-2.175 2.22-2.22-.746-.746-2.22 2.22-2.22-2.22-.747.746 2.22 2.22-2.176 2.177.746.746 2.177-2.177 2.176 2.175z"/></svg></div><div class="col col--6 col--offset-1"><div class=text--left><h3 class=padding-vert--md>Powered by MDX</h3><p>Compatible with MDX, GraphQL-Markdown allows you to customize the look and feel of your documentation.</div></div></div><div class="row margin-vert--lg padding-vert--lg feature_CLW0"><div class="col col--2 col--offset-2"><svg xmlns=http://www.w3.org/2000/svg xml:space=preserve viewBox="0 0 474.085 474.085" class=featureSvg_GfXr role=img><circle cx=237.042 cy=236.966 r=236.966 style=fill:#acddde /><path d="M237.016 474.085c100.781 0 186.811-62.944 221.071-151.635-61.87-37.302-142.318-55-230.279-55-80.886 0-155.414 14.982-214.998 46.39 31.902 93.204 120.196 160.245 224.206 160.245" style=fill:#9aca42 /><path d="M130.765 212.764c0-57.724 34.836-104.515 104.511-104.515s104.515 46.791 104.515 104.515c0 57.72-37.743 104.515-104.515 104.515s-104.511-46.795-104.511-104.515" style=fill:#84b340 /><path d="m231.65 369.54 3.54-200.596a7.35 7.35 0 0 1 14.698 0l3.536 200.596c0 6.013-21.774 6.013-21.774 0" style=fill:#49341b /><path d="M243.25 292.411a8.3 8.3 0 0 1-3.839-.939 8.345 8.345 0 0 1-3.57-11.255l47.472-86.292c1.523-2.93 5.134-4.075 8.056-2.556a5.976 5.976 0 0 1 2.552 8.06l-43.247 88.47a8.37 8.37 0 0 1-7.424 4.512" style=fill:#49341b /><path d="M240.096 298.881a9.7 9.7 0 0 1-8.108-4.355l-52.845-85.436c-1.961-2.978-1.152-6.99 1.826-8.958 2.967-1.972 6.99-1.156 8.962 1.822l58.252 81.858a9.7 9.7 0 0 1-2.739 13.452 9.6 9.6 0 0 1-5.348 1.617" style=fill:#49341b /></svg></div><div class="col col--6 col--offset-1"><div class=text--left><h3 class=padding-vert--md>Treeware ♥ Open-source</h3><p>GraphQL-Markdown packages are 100% free and open-source, under the MIT license.<br>If you use it in production, then we ask that you<!-- --> <a target=_blank rel="noopener noreferrer" href=https://plant.treeware.earth/graphql-markdown/graphql-markdown>buy the world a tree</a> <!-- -->to thank us for our work.</div></div></div></div></div></section></main><div class="col col--6 col--offset-3 padding-bottom--xl"><div class=text--center><h3 class=padding-bottom--md>Thanks to our contributors</h3><a href=https://github.com/graphql-markdown/graphql-markdown/graphs/contributors><img src="https://contrib.rocks/image?repo=graphql-markdown/graphql-markdown&columns=8" alt=contributors></a></div></div></div><footer class=footer><div class="container container-fluid"><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2020-2025 Grégory Heitz. Built with Docusaurus.</div></div></div></footer></div>