Aktiviere die Unterstützung für Titelseiten, indem du coverpage
auf true einstellst, vergleiche coverpage Einstellungen.
Setze coverpage
auf true, und erstelle _coverpage.md
:
<!-- index.html -->
<script>
window.$docsify = {
coverpage: true
}
</script>
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
<!-- _coverpage.md -->
![logo](_media/icon.svg)
# docsify <small>4.7.0</small>
> Ein magischer Generator für Dokumentationsseiten.
* Einfach und wenig Speicherbedarf (~19kB gzipped)
* Keine statischen HTML Dateien
* Mehrere Themes
[GitHub](https://github.com/docsifyjs/docsify/)
[Schnellstart](#docsify)
Die Hintergrundfarbe wird in der Standardeinstellung zufällig generiert. Du kannst sie anpassen, oder auch ein Hintergrundbild verwenden:
<!-- _coverpage.md -->
# docsify <small>4.7.0</small>
[GitHub](https://github.com/docsifyjs/docsify/)
[Schnellstart](#quick-start)
<!-- Hintegrundbild -->
![](_media/bg.png)
<!-- Hintegrundfarbe -->
![color](#f0f0f0)
Für gewöhnlich werden die Titelseite und die Startseite zusammen auf einer Seite angezeigt.
Diese kann man natürlich auch mit der onlyCover
Einstellung ändern.
Sollte deine Dokumentation in mehreren Sprachen zur Verfügung stehen, macht es Sinn, auch mehrere Titelseiten zu erstellen.
Für folgende Struktur:
.
└── docs
├── README.md
├── guide.md
├── _coverpage.md
└── de-de
├── README.md
└── guide.md
└── _coverpage.md
definiere wie folgt:
window.$docsify = {
coverpage: ['/', '/de-de/']
};
oder bei Verwendung abweichender Dateinamen:
window.$docsify = {
coverpage: {
'/': 'cover.md',
'/de-de/': 'cover.md'
}
};