Zum Hauptinhalt springen

14 docs getaggt mit "software"

Alle Tags anzeigen

Adding the CMS to an iPad home screen

Mit Apple iPadOS können Sie jede Webseite in eine Web-App umwandeln, die in einer eigenen Instanz von Safari mit einem eigenen Symbol auf Ihrem Startbildschirm ausgeführt wird. Mit dieser Funktion können Sie eine App für das cloudbasierte CMS erstellen.

Browser support

Mit DocStatic können Sie die Liste der unterstützten Browser über eine Browsersliste-Konfiguration definieren. In der Regel sollten Websites auf jedem modernen Browser gut funktionieren.

CLI

DocStatic bietet eine Reihe von Skripten, die Ihnen beim Erstellen, Bereitstellen und Veröffentlichen Ihrer Website helfen.

Deployment

Standardmäßig wird DocStatic auf GitHub Pages bereitgestellt. Weitere Optionen finden Sie unter Bereitstellung in der Docusaurus-Dokumentation.

Hosted CMS

Eine der beiden Kernkomponenten von DocStatic ist das CMS (die andere ist das SSG). Bislang haben Sie wahrscheinlich nur die lokale Version verwendet, die über die Befehlszeile mit „yarn dev“ aufgerufen wird. DocStatic unterstützt jedoch auch zwei Möglichkeiten, eine gehostete Version des CMS zu verwenden.

Installation

Willkommen! Diese Anleitung führt Sie durch die erstmalige Einrichtung von DocStatic.

Introduction

DocStatic ist eine moderne Dokumentationsplattform, die die Lücke zwischen Autoren und Entwicklern schließt und Ihnen dabei hilft, Online-Dokumentationen zu erstellen, die Ihre Benutzer lieben werden.

Notifications

DocStatic verwendet GitHub Actions, um Workflow-Benachrichtigungen zu versenden. Beispiele für Überprüfungs- und Übersetzungsbenachrichtigungen finden Sie im Ordner „.github/workflows/“. Um diese zu aktivieren, sind einige Konfigurationen in GitHub erforderlich. Sie können sie auch als Ausgangspunkt für die Entwicklung Ihrer eigenen benutzerdefinierten Benachrichtigungen verwenden.

Search

Standardmäßig ist DocStatic für die Verwendung der Lunr-Suche konfiguriert. Der Hauptvorteil dieser Lösung besteht darin, dass sie kostenlos ist. Der größte Nachteil ist, dass der gesamte Suchindex auf den Browser des Benutzers heruntergeladen wird. Je größer Ihre Website ist, desto langsamer wird sie.

Static assets

Statische Assets sind Nicht-Code-Dateien, die direkt in die Build-Ausgabe kopiert werden. Dazu gehören Bilder, Stylesheets, Favicons, Schriftarten usw.

Style checking

Eine der Funktionen, die Autoren, die mit Docs-as-Code arbeiten, am meisten vermissen, ist eine gute Rechtschreib-, Grammatik- und Stilprüfung. Standardmäßig wird die Rechtschreibprüfung von Ihrem Webbrowser oder Ihrer integrierten Entwicklungsumgebung bereitgestellt. Dies mag für einfache Websites ausreichend sein, aber wenn Sie etwas Fortgeschritteneres benötigen, brauchen Sie einen speziellen Grammatikprüfer.

Using plugins

Der Kern des statischen Website-Generators bietet keine eigenen Funktionen. Alle Funktionen werden an einzelne Plugins delegiert: die Dokumentationsfunktion wird vom Dokumentations-Plugin bereitgestellt; die Blog-Funktion wird vom Blog-Plugin bereitgestellt; oder einzelne Seiten werden vom Seiten-Plugin bereitgestellt.