3.5 KiB

Raw Blame History

Inbetriebnahme

Ähnlich wie bei GitBook, kannst du deine Dateien über GitHub Pages, Gitlab Pages oder VPS erstellen.

GitHub Pages

Bei der Verwendung von GitHub Pages kannst du folgende drei Orte verwenden, um die Dokumentation für dein GitHub repository zu verwalten:

docs/ Ordner
master branch
gh-pages branch

Es wird empfohlen, deine Dateien im ./docs Unterordner im master branch deines repository zu speichern. Wechsle dann zu den Einstellungen deines repository und wähle master branch /docs folder als deine GitHub Pages Quelle.

!> Du kannst die Dateien auch im Hauptverzeichnis speichern und dann master branch in den Einstellungen auswählen.

GitLab Pages

Wenn du mit GitLab Pages über den master branch deployst, verwende eine .gitlab-ci.yml Datei mit folgendem Code:

?> Der Trick mit dem .public Verzeichnis wird verwendet, damit cp nicht auch public/ in sich selbst in einer ewigen Schleife kopiert.

pages:
  stage: deploy
  script:
  - mkdir .public
  - cp -r * .public
  - mv .public public
  artifacts:
    paths:
    - public
  only:
  - master

!> Du kannst auch script mit - cp -r docs/. public, sollte ./docs dein docsify Unterverzeichnis sein.

Firebase Hosting

!> Du musst das Firebase CLI mithilfe von npm i -g firebase-tools installieren, nachdem du dich unter Firebase Console mit einem Google Konto angemeldet hast.

Verwende das Terminal, um das Unterverzeichnis deines Firebase Projektes zu finden und anzusteuern - es könnte z.B. ~/Projects/Docs sein. Führe dort firebase init aus, dann wähle Hosting über das Menü (verwende Leerzeichen, um auszuwählen, Pfeiltasten, um die Einstellungen zu ändern, and die Entertaste, um zu bestätigen). Folge den Anweisungen für die Einrichtung.

Deine firebase.json Datei sollte wie folgt aussehen (Ich habe mein deploy Verzeichnis von public zu site geändert):

{
  "hosting": {
    "public": "site",
    "ignore": ["firebase.json", "**/.*", "**/node_modules/**"]
  }
}

Sobald du fertig bist, baue die Vorlage, indem du docsify init ./site ausführst (ersetze site mit deinem deployment Verzeichnis, welches du beim Ausführen von firebase init gewählt hast - public ist hier die Standardeinstellung). Nimm Änderungen an deiner Dokumentation vor und führe firebase deploy in dem Verzeichnis deines Projektes aus.

VPS

Versuche es mit folgender nginx Einstellung:

server {
  listen 80;
  server_name  your.domain.com;

  location / {
    alias /path/to/dir/of/docs;
    index index.html;
  }
}

Netlify

Melde dich mit deinem Netlify Konto an.
In den Einstellungen wähle New site from Git.
Wähle das Verzeichnis, in dem du deine Dokumentation erstellst. Lasse Build Command leer, und wähle für die Einstellung publish directory jenes Unterverzeichnis, in welchem sich die Datei index.html von docsify für deine Dokumentation befindet. Meistens ist dies docs, weil docs/index.html.

HTML5 router

Bei der Verwendung des HTML5 router musst du Umleitungsregeln erstellen, die alle Anfragen an index.html umleitet. Mit Netlify ist dies einfach. Erstelle eine \redirects Datei im docs Unterverzeichnis mit:

/*    /index.html   200

3.5 KiB Raw Blame History