Γιατί υπάρχει
Παρέχουμε μια εφαρμογή με έμφαση στην τεκμηρίωση που αποδεικνύει ότι το περιεχόμενο που διαχειρίζεται ένα CMS μπορεί να μετατραπεί σε έναν προσεγμένο ιστότοπο τεκμηρίωσης χωρίς να ανακατασκευαστεί το επίπεδο απόδοσης.
Χρησιμοποιήστε το όταν
- φιλοξενείτε τεκμηρίωση προϊόντος πάνω σε περιεχόμενο CMS
- αποδίδετε έγγραφα με έντονη χρήση Markdown
- δημιουργείτε πλοήγηση τεκμηρίωσης με πλαϊνή στήλη και αναζήτηση
Τι περιλαμβάνει
- εφαρμογή Next.js docs-template
- απόδοση catch-all διαδρομών με υποστήριξη CMS
- όριο markdown τεκμηρίωσης
- εξαρτήματα γραμμής πλοήγησης, πλαϊνής στήλης και περιεχομένου ειδικά για τεκμηρίωση
- φόρτωση αναρτήσεων και κατηγοριών με επίγνωση γλώσσας
Βασική ροή εργασίας
- Ρυθμίστε την εφαρμογή τεκμηρίωσης με μεταβλητές περιβάλλοντος του CMS.
- Αποδώστε τις διαδρομές τεκμηρίωσης μέσω του
cms-renderer. - Ανακτήστε έγγραφα κατηγοριών και αναρτήσεων από τα σχήματα του CMS.
- Αποδώστε περιεχόμενο Markdown με εξαρτήματα ειδικά για την τεκμηρίωση.
- Προσθέστε πιο πλούσια πλοήγηση και αναζήτηση από πάνω.
Επιφάνειες συστήματος
- επίπεδο διαδρομών της εφαρμογής τεκμηρίωσης
- επίπεδο εξαρτημάτων διεπαφής τεκμηρίωσης
- βοηθήματα δεδομένων CMS και URL για τεκμηρίωση