Skip to content

Latest commit

 

History

History
470 lines (334 loc) · 8.06 KB

configuration.md

File metadata and controls

470 lines (334 loc) · 8.06 KB
Raw

Einstellungen

Du kannst Einstellungen für window.$docsify wie folgt ändern:

<script>
  window.$docsify = {
    repo: 'docsifyjs/docsify',
    maxLevel: 3,
    coverpage: true
  }
</script>

el

  • Typ: String
  • Standard: #app

Das DOM Element kann bei der Initialisierung gesetzt werden. Es kann ein CSS selector string oder ein richtiges HTML Element sein.

window.$docsify = {
  el: '#app'
};

repo

  • Typ: String
  • Standard: null

Verwende die repository URL oder eine Zeichenfolge aus Benutzername/repo, um das GitHub Corner widget in der oberen rechten Ecke der Seite zu implementieren.

window.$docsify = {
  repo: 'docsifyjs/docsify',
  // oder
  repo: 'https://github.com/docsifyjs/docsify/'
};

maxLevel

  • Typ: Number
  • Standard: 6

Maximale Anzahl der Inhaltsübersichtebenen.

window.$docsify = {
  maxLevel: 4
};

loadNavbar

  • Typ: Boolean|String
  • Standard: false

Lädt die Navigationsleiste von der Markdown Datei _navbar.md falls true, oder vom gewählten Pfad.

window.$docsify = {
  // lade von _navbar.md
  loadNavbar: true,

  // lade von nav.md
  loadNavbar: 'nav.md'
};

loadSidebar

  • Typ: Boolean|String
  • Standard: false

Lädt das seitliche Inhaltsverzeichnis von der Markdown Datei _sidebar.md falls true, oder vom gewählten Pfad.

window.$docsify = {
  // lade von _sidebar.md
  loadSidebar: true,

  // lade von summary.md
  loadSidebar: 'summary.md'
};

subMaxLevel

  • Typ: Number
  • Standard: 0

Wähle die maximale Anzahl der Unterpunkte pro Datei in der Inhaltsübersicht.

window.$docsify = {
  subMaxLevel: 2
};

auto2top

  • Typ: Boolean
  • Standard: false

Scrolle zum Anfang der Seite, wenn die Route gewechselt wird.

window.$docsify = {
  auto2top: true
};

homepage

  • Typ: String
  • Standard: README.md

README.md in deinem Ordner für die Dokumentation wird als Startseite für deine Webseite gesetzt, aber manchmal musst du das vielleicht ändern.

window.$docsify = {
  // Wähle /home.md
  homepage: 'home.md',

  // Oder verwende das README in deinem repo
  homepage:
    'https://raw.githubusercontent.com/docsifyjs/docsify/master/README.md'
};

basePath

  • Typ: String

Der Basispfad der Webseite. Du kannst einen anderen Ordner wählen, oder eine andere Domain.

window.$docsify = {
  basePath: '/path/',

  // Lade die Dateien von einer anderen Domain
  basePath: 'https://docsify.js.org/',

  // Oder lade Dateien von einem anderen repo
  basePath:
    'https://raw.githubusercontent.com/ryanmcdermott/clean-code-javascript/master/'
};

coverpage

  • Typ: Boolean|String
  • Standard: false

Aktiviere das Titelseitenfeature. Falls true, wird sie von _coverpage.md geladen.

window.$docsify = {
  coverpage: true,

  // Anderer Dateiname
  coverpage: 'cover.md',

  // mutiple covers
  coverpage: ['/', '/zh-cn/'],

  // mutiple covers and custom file name
  coverpage: {
    '/': 'cover.md',
    '/zh-cn/': 'cover.md'
  }
};

logo

  • Type: String

Das Webseitenlogo, wie es in der Sidebar erscheint. Du kannst seine Größe mit CSS ändern.

window.$docsify = {
  logo: '/_media/icon.svg'
};

name

  • Typ: String

Webseitenname, wie er in der Inhaltsübersicht in der Seitenleiste angezeigt wird.

window.$docsify = {
  name: 'docsify'
};

nameLink

  • Typ: String
  • Standard: window.location.pathname

Der Name der Links.

window.$docsify = {
  nameLink: '/',

  // Für jede Route
  nameLink: {
    '/zh-cn/': '/zh-cn/',
    '/': '/'
  }
};

markdown

  • Typ: Function

Siehe Markdown Konfiguration.

window.$docsify = {
  // Objekt
  markdown: {
    smartypants: true,
    renderer: {
      link: function() {
        // ...
      }
    }
  },

  // Funktion
  markdown: function(marked, renderer) {
    // ...
    return marked;
  }
};

themeColor

  • Typ: String

Passe die Farbe der Themen an. Verwende CSS3 Variablen und polyfill in älteren Browsern.

window.$docsify = {
  themeColor: '#3F51B5'
};

alias

  • Typ: Object

Verwende alternative Routen. Du kannst sie ungehindert anpassen. Supports RegExp.

window.$docsify = {
  alias: {
    '/foo/(+*)': '/bar/$1', // supports regexp
    '/zh-cn/changelog': '/changelog',
    '/changelog':
      'https://raw.githubusercontent.com/docsifyjs/docsify/master/CHANGELOG',
    '/.*/_sidebar.md': '/_sidebar.md' // See #301
  }
};

autoHeader

  • Typ: Boolean

Sollten loadSidebar und autoHeader beide aktiviert sein, setze einen Header vor die Seite in jedem Link in _sidebar.md, bevor sie in HTML umgewandelt wird. Vergleiche #78.

window.$docsify = {
  loadSidebar: true,
  autoHeader: true
};

executeScript

  • Typ: Boolean

Führe das Skript auf der Seite aus. Analysiere nur das erste script tag (demo). Sollte Vue verwendet sein, wird es in der Standardeinstellung ausgeführt.

window.$docsify = {
  executeScript: true
};
## Dies ist ein Test

<script>
  console.log(2333)
</script>

?> Nehme zur Kenntnis, dass, solltest du ein externes Skript ausführen, z.B. ein eingebettete jsfiddle demo, du sicher gehen solltest, das external-script plugin zu verwenden.

noEmoji

  • type: Boolean

Verhindere die Umwandlung in Emoji:

window.$docsify = {
  noEmoji: true
};

mergeNavbar

  • type: Boolean

Navbar will be merged with the sidebar on smaller screens.

window.$docsify = {
  mergeNavbar: true
};

formatUpdated

  • type: String|Function

Du kannst das Datum der letzten Änderung mithilfe der Variable {docsify-updated} anzeigen. Dessen Format kannst du über formatUpdated in den Einstellungen ändern wie folgt ändern:

Siehe auch https://github.com/lukeed/tinydate#patterns

window.$docsify = {
  formatUpdated: '{MM}/{DD} {HH}:{mm}',

  formatUpdated: function(time) {
    // ...

    return time;
  }
};

externalLinkTarget

  • type: String
  • default: _blank

Das Ziel externer Links. Standard ist _blank (neues Fenster / neuer Tab):

window.$docsify = {
  externalLinkTarget: '_self' // default: '_blank'
};

routerMode

  • type: String
  • default: history
window.$docsify = {
  routerMode: 'history' // default: 'hash'
};

noCompileLinks

  • type: Array

Manchmal möchten wir nicht, dass docsify die Verwaltung unserer Links übernimmt, vergleiche #203.

window.$docsify = {
  noCompileLinks: ['/foo', '/bar/.*']
};

requestHeaders

  • type: Object

Ändere die Header für Anfragen.

window.$docsify = {
  requestHeaders: {
    'x-token': 'xxx'
  }
};

ext

  • type: String

Dateiendung für Anfragen.

window.$docsify = {
  ext: '.md'
};

fallbackLanguages

  • type: Array<string>

Liste der Sprachen, für die bei angefragten Seiten, welche nicht gefunden wurden, auf die Seiten der Standardsprache zurückgegriffen wird.

Beispiel der Abfolge von Anfragen:

  • Versuch einer Anfrage für /de/overview. Wenn sie existiert, wird sie angezeigt.
  • Danach Versuch einer Anfrage an /overview (abhängig von der Standardsprache). Darstellung dieser, wenn sie existiert.
  • Danach Anzeige der 404 (Fehler-) Seite.
window.$docsify = {
  fallbackLanguages: ['fr', 'de']
};

notFoundPage

  • type: Boolean | String | Object

Lade die _404.md Datei:

window.$docsify = {
  notFoundPage: true
};

Lade einen eigens definierten Zielpfad für die 404 Seite:

window.$docsify = {
  notFoundPage: 'my404.md'
};

Lade die richtige 404 Seite abhängig von der aktuellen Sprache:

window.$docsify = {
  notFoundPage: {
    '/': '_404.md',
    '/de': 'de/_404.md'
  }
};

Notiz: Die Einstellungen für fallbackLanguages funktionieren aktuell nicht bei gleichzeitiger Verwendung von notFoundPage.