Markdoc είναι εξαιρετική για την τεχνική τεκμηρίωση, εγχειρίδια, εσωτερικές wikis έργου, ή στατική ιστοσελίδα γενιές.
Τεχνική τεκμηρίωση / Εγχειρίδια, Markdoc μπορεί να χρησιμοποιηθεί για να γράψει και να καταστήσει χειρόγραφη οδηγούς και εγχειρίδια για το λογισμικό. Η τεκμηρίωση θα είναι κανονικά ξεχωριστά από αυτόματα δημιουργείται τεκμηρίωση API, και θα μπορούσε να δώσει μια άποψη υψηλότερο επίπεδο από ό, τι docs API μόνο. Θα μπορούσε να χρησιμοποιηθεί για την τεκμηρίωση πελάτη για το web / desktop εφαρμογές, ή ακόμα και την τεκμηρίωση του έργου για πλαισίων.
Για εσωτερικό σχέδιο Wikis, wikis Markdoc αποτελούνται από ένα ενιαίο αρχείο απλού κειμένου ανά σελίδα. Με το συνδυασμό ένα wiki με DVCS (όπως Mercurial ή Git), μπορείτε να συνεργαστείτε με πολλούς άλλους ανθρώπους. Χρησιμοποιήστε τα DVCS να παρακολουθείτε, να μοιραστούν και να συγχωνεύσει τις αλλαγές με το ένα το άλλο, και να δείτε το wiki & rsquo? S ιστορία.
Για στατικά γενιάς του δικτυακού τόπου, Markdoc μετατρέπει τα wikis σε πρώτες αρχεία HTML και τα μέσα ενημέρωσης. Αυτό σας επιτρέπει να διαχειριστείτε ένα blog, προσωπική ιστοσελίδα ή μια συλλογή των σελίδων σε ένα wiki Markdoc, ίσως με προσαρμοσμένα στυλ CSS, και δημοσιεύει το κατέστησε HTML σε μια ιστοσελίδα. Markdoc δεν χρειάζεται να εγκατασταθεί στο χώρο φιλοξενίας, δεδομένου ότι το προκύπτον HTML είναι εντελώς ανεξάρτητη
Χαρακτηριστικά :.
- Ρύθμιση Google παρακολούθησης του Analytics σε μια γραμμή ρυθμίσεων.
- Barebones wikis που απλά μοιάζουν με τους καταλόγους με Markdown διαμορφωμένη αρχεία κειμένου σε αυτά.
- Ένα ενσωματωμένο διακομιστή HTTP και η εφαρμογή WSGI να σερβίρετε ένα wiki που καταρτίζονται με μία μόνο εντολή.
- Συνεχής χτίζει (μέσω rsync) σημαίνει ότι ο διακομιστής μπορεί να συνεχίσει να τρέχει, ενώ Markdoc re-compile το wiki. Απλά ανανεώστε το πρόγραμμα περιήγησής σας για να δείτε τις αλλαγές.
- Προσθήκη Pygments-powered επισήμανση σύνταξης Markdoc wiki σας με μία μόνο παράμετρο διαμόρφωσης.
- Markdoc είναι λογισμικό δημόσιο τομέα. Θα είναι πάντα απολύτως ελεύθεροι να χρησιμοποιούν, και μπορείτε να το αναδιανείμει (εν μέρει ή εν όλω) κάτω από οποιεσδήποτε συνθήκες (open-source, ιδιόκτητα ή μη) χωρίς αναφορά ή encumberances.
Απαιτήσεις :
- argparse
- CherryPy
- Jinja2
- Markdown
- Pygments
- PyYAML
- webob
- Python 2.4 ή νεότερη έκδοση
- rsync
Τα σχόλια δεν βρέθηκε