{
    "componentChunkName": "component---src-templates-plugin-docs-tsx",
    "path": "/plugins/scm-documentation-viewer-plugin/docs/1.1.x/de/overview/",
    "result": {"data":{"plugin":{"name":"scm-documentation-viewer-plugin","displayName":"Documentation Viewer","description":"Plugin to view and edit the markdown documentation of a repository","author":"Cloudogu GmbH","documentation":[{"version":"1.1.x","languages":["de","en"]},{"version":"1.0.x","languages":["de","en"]}]},"navigation":{"nodes":[{"section":"Features","entries":[{"frontmatter":{"title":"Übersicht","subtitle":null,"partiallyActive":null},"fields":{"slug":"/plugins/scm-documentation-viewer-plugin/docs/1.1.x/de/overview/"}},{"frontmatter":{"title":"Markdown Text Editor","subtitle":null,"partiallyActive":null},"fields":{"slug":"/plugins/scm-documentation-viewer-plugin/docs/1.1.x/de/markdown-text-editor/"}}]}]},"versions":{"group":[{"fieldValue":"1.0.x"},{"fieldValue":"1.1.x"}]},"languages":{"group":[{"fieldValue":"de"},{"fieldValue":"en"}]},"markdownRemark":{"html":"<p>Das Documentation-Viewer Plugin vereinfacht das Verwalten einer Markdown-Dokumentation innerhalb eines Repositories.</p>\n<h2 id=\"konfiguration\" style=\"position:relative;\"><a href=\"#konfiguration\" aria-label=\"konfiguration permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a>Konfiguration</h2>\n<p>Konfiguriert wird dieses Plugin über eine <code class=\"language-text\">documentation.yaml</code> Datei, welche sich im Root-Verzeichnis des jeweiligen Repositories befinden muss.\nAlternativ ist auch eine <code class=\"language-text\">documentation.yml</code> erlaubt.\nEs dürfen sich aber nicht beide Dateien im Root-Verzeichnis des Repositories befinden.</p>\n<p><span\n      class=\"gatsby-resp-image-wrapper\"\n      style=\"position: relative; display: block; margin-left: auto; margin-right: auto; max-width: 590px; \"\n    >\n      <span\n    class=\"gatsby-resp-image-background-image\"\n    style=\"padding-bottom: 41.891891891891895%; position: relative; bottom: 0; left: 0; background-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAICAYAAAD5nd/tAAAACXBIWXMAAAsTAAALEwEAmpwYAAABGklEQVQoz61SW26DQAzk7PnqWXqESr1D1P/8tE0IAQnSxd6HzU5llxAOUEuDvWPWjEc0RIS2bdHfbui6znE+nz33fY/22qKUAotaqz3XjI1bVljd2MBhGEAcwSljZgbRDOMfYGbEGEHMmAIh84z3r4DXU8DbN+Nw/MHheMfLxx2NiCIVQVGFLgtUFcsuG0TE4VytKDnhMhE+J0IXEk5jxGUu6FjR2BAfuK5lYbUNyjkh57zxIsWVmoiqAlT14YXJa4tGdAFncTzCLpmaEIKvuefHcfSeuSgVf5bE6H1T35g6LgrKilh0W9FySglE7NnOptzXVkUxq0TBTJimyd9xhdV8cr+entmlvYd7fjvr8+Nmi/V8IP4x7Lf5BYzAcLdsX1K6AAAAAElFTkSuQmCC'); background-size: cover; display: block;\"\n  ></span>\n  <img\n        class=\"gatsby-resp-image-image\"\n        alt=\"Konfigurationsdatei im Repository\"\n        title=\"Konfigurationsdatei im Repository\"\n        src=\"/static/3277658d05f6d7a33ab0c8bb8b1a3b9d/fcda8/documentationYamlInRepository.png\"\n        srcset=\"/static/3277658d05f6d7a33ab0c8bb8b1a3b9d/12f09/documentationYamlInRepository.png 148w,\n/static/3277658d05f6d7a33ab0c8bb8b1a3b9d/e4a3f/documentationYamlInRepository.png 295w,\n/static/3277658d05f6d7a33ab0c8bb8b1a3b9d/fcda8/documentationYamlInRepository.png 590w,\n/static/3277658d05f6d7a33ab0c8bb8b1a3b9d/efc66/documentationYamlInRepository.png 885w,\n/static/3277658d05f6d7a33ab0c8bb8b1a3b9d/c83ae/documentationYamlInRepository.png 1180w,\n/static/3277658d05f6d7a33ab0c8bb8b1a3b9d/91608/documentationYamlInRepository.png 1251w\"\n        sizes=\"(max-width: 590px) 100vw, 590px\"\n        style=\"width:100%;height:100%;margin:0;vertical-align:middle;position:absolute;top:0;left:0;\"\n        loading=\"lazy\"\n        decoding=\"async\"\n      />\n    </span></p>\n<p>In dieser Yaml-Datei dürfen zwei Werte festgelegt werden.\nZum einen der <code class=\"language-text\">basePath</code> und die <code class=\"language-text\">landingPage</code>.\nDer <code class=\"language-text\">basePath</code> legt den Pfad fest in dem die Dokumentation im Repository liegt.\nDie <code class=\"language-text\">landingPage</code> ist der Dateiname der Startseite der Dokumentation.\nDa hier lediglich eine Markdown-Dokumentation unterstützt wird, muss die Startseite ebenfalls eine Markdown-Datei sein (.md Endung).\nIm Folgenden wird ein Beispielkonfiguration dargestellt:</p>\n<div class=\"gatsby-highlight\" data-language=\"yaml\"><pre class=\"language-yaml\"><code class=\"language-yaml\"><span class=\"token key atrule\">basePath</span><span class=\"token punctuation\">:</span> <span class=\"token string\">'/docs'</span>\n<span class=\"token key atrule\">landingPage</span><span class=\"token punctuation\">:</span> <span class=\"token string\">'home.md'</span></code></pre></div>\n<p>Diese Werte sagen aus, dass die Dokumentation unter <code class=\"language-text\">/docs</code> liegt und das sich darin die Startseite mit dem Namen <code class=\"language-text\">home.md</code> befindet.\nBeide Werte sind Optional und müssen nicht gesetzt werden.\nFalls die Werte nicht gesetzt sind, wird ein Default-Wert genutzt.\nDie Default-Werte können dem oben genannten Beispiel entnommen werden.</p>\n<h2 id=\"aufrufen-der-dokumentation\" style=\"position:relative;\"><a href=\"#aufrufen-der-dokumentation\" aria-label=\"aufrufen der dokumentation permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a>Aufrufen der Dokumentation</h2>\n<p>Sobald das Plugin konfiguriert wurde, erscheint in der Repository-Navigation ein weiterer Eintrag.\nDieser kann geklickt werden, um direkt zur Startseite der Dokumentation zu springen.</p>\n<p><span\n      class=\"gatsby-resp-image-wrapper\"\n      style=\"position: relative; display: block; margin-left: auto; margin-right: auto; max-width: 590px; \"\n    >\n      <span\n    class=\"gatsby-resp-image-background-image\"\n    style=\"padding-bottom: 44.5945945945946%; position: relative; bottom: 0; left: 0; background-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAJCAYAAAAywQxIAAAACXBIWXMAAAsTAAALEwEAmpwYAAABa0lEQVQoz22SvW7cMBCE9cKu0/stAuQ5UqY14MJAiuRc3iEBzkVOEsX/3y/YlXVwgFAYULtcLmeGnGJKWB/YnMdsllIbrQ9q71Sdd7RxAGDox38wvV2v/DydOJ/PXC4XYoyMMeit/YMqqJVSCmuqbLlxS43vc+HHUnj5k7n6xmTtxrquxJz19Jgr3nt8CPvsPSEEVhdYjGGeZ768Gj6fDN9+Oz4933h8mXl4mvn6KzDl1vGl0YRJ7woVNVSbDs19iK1zhBhJKWLWBWftu2SY+hi6mHO+bxBGIs1ai3NOcxIbY0gp6eGjd2IILPONVuudxFRax6Wi/uzJfbPEslkgQ5qIv0edDJ8LW6oc3LVhqp2tDHwd9LHflDIYQ1kfbCV3+CkWlA4xZX0ZokLWVXLUhh2TO7Z0+kAbSYEUikyJpakwVK/HIDbUw2WZtebwfhIJuRRyqaRSKO9PQyCNjmaHDe3+fPb/4zJFkUj+C8yMvM0vthPmAAAAAElFTkSuQmCC'); background-size: cover; display: block;\"\n  ></span>\n  <img\n        class=\"gatsby-resp-image-image\"\n        alt=\"Link zur Dokumentation\"\n        title=\"Link zur Dokumentation\"\n        src=\"/static/fe6817e9ac4b79b53af51ce5575eda51/fcda8/documentation-viewer-link.png\"\n        srcset=\"/static/fe6817e9ac4b79b53af51ce5575eda51/12f09/documentation-viewer-link.png 148w,\n/static/fe6817e9ac4b79b53af51ce5575eda51/e4a3f/documentation-viewer-link.png 295w,\n/static/fe6817e9ac4b79b53af51ce5575eda51/fcda8/documentation-viewer-link.png 590w,\n/static/fe6817e9ac4b79b53af51ce5575eda51/efc66/documentation-viewer-link.png 885w,\n/static/fe6817e9ac4b79b53af51ce5575eda51/c83ae/documentation-viewer-link.png 1180w,\n/static/fe6817e9ac4b79b53af51ce5575eda51/a4f81/documentation-viewer-link.png 1508w\"\n        sizes=\"(max-width: 590px) 100vw, 590px\"\n        style=\"width:100%;height:100%;margin:0;vertical-align:middle;position:absolute;top:0;left:0;\"\n        loading=\"lazy\"\n        decoding=\"async\"\n      />\n    </span></p>","description":"Das Documentation-Viewer Plugin vereinfacht das Verwalten einer Markdown-Dokumentation innerhalb eines Repositories. Konfiguration Konfiguriert wird dieses…","tableOfContents":"<ul>\n<li><a href=\"#konfiguration\">Konfiguration</a></li>\n<li><a href=\"#aufrufen-der-dokumentation\">Aufrufen der Dokumentation</a></li>\n</ul>","frontmatter":{"title":"Übersicht","subtitle":null,"description":null,"keywords":null,"displayToc":null,"image":null}}},"pageContext":{"name":"scm-documentation-viewer-plugin","slug":"/plugins/scm-documentation-viewer-plugin/docs/1.1.x/de/overview/","version":"1.1.x","latestVersion":"1.1.x","latestPageVersion":"1.1.x","language":"de","canonicalPath":"/plugins/scm-documentation-viewer-plugin/docs/latest/de/overview/","latestRootPath":"/plugins/scm-documentation-viewer-plugin/docs/1.1.x/de/"}},
    "staticQueryHashes": ["1973669194","2742214048","2956773653","2957019495","698804963"]}