Markdoc

Markdoc είναι προσανατολισμένη προς τη διαχείριση της τεχνικής τεκμηρίωσης, αλλά μπορεί να χρησιμοποιηθεί για διάφορους σκοπούς. Markdoc διαθέτει κάποια σημαντικά σημεία πώλησης:
* Wikis είναι κατασκευασμένα εξ ολοκλήρου από αρχεία κειμένου, ώστε να μπορείτε να βάλετε εύκολα κάτω από τον έλεγχο έκδοσης.
* Wikis συγκεντρώνει σε αυτόνομο καταλόγους HTML, τα οποία μπορούν να διανεμηθούν ως συμπιεσμένα αρχεία ή να σερβίρονται από ένα διακομιστή HTTP.
* Μπορείτε προαιρετικά να περιλαμβάνει το στατικό περιεχόμενο που θα συγκεντρωθούν στον κατάλογο HTML μαζί με όλες τις σελίδες που αποδίδονται σας.
* Markdoc έρχεται με ένα πλήρως λειτουργικό καθαρής Python WSGI εφαρμογή και HTTP server για να εξυπηρετήσει επάνω καταρτίζονται wikis.
* Μπορείτε να καταστήσει wiki σας με μια ποικιλία των επεκτάσεων Markdown, όπως Pygments με βάση τον κωδικό ανάδειξη, εκτεταμένη σύνταξη για τους καταλόγους ορισμό, την παραγωγή TOC, κλπ.
* Μπορείτε πλήρως να προσαρμόσετε τον τρόπο wiki σας αποδίδεται με την επεξεργασία των προτύπων Jinja2 χρησιμοποιείται για τη μετατροπή καταστεί Markdown σε πλήρη έγγραφα HTML.
γρήγορης εκκίνησης
Εγκατάσταση:
#! / Bin / bash
Hg κλώνος ssh: //hg@bitbucket.org/zacharyvoase/markdoc
cd markdoc /
PIP εγκαταστήσετε -r ΑΠΑΙΤΗΣΕΙΣ
python setup.py εγκαταστήσετε
Κάνοντας ένα Wiki
#! / Bin / bash
markdoc init μου-wiki
cd μου-wiki /
vim wiki / somefile.md
# ... Γράφετε κάποια έγγραφα ...
markdoc κατασκευής
markdoc εξυπηρετούν
# .. Ανοιχτό http: // localhost: 8008 / σε ένα πρόγραμμα περιήγησης ...
Διάταξη
Wikis Markdoc έχουν την ακόλουθη προεπιλεγμένη διάταξη:
WIKI_ROOT /
| - .html /
| - .templates /
| - .tmp /
| - Στατική /
| - Wiki /
`- Markdoc.yaml
Η .html / και .tmp / καταλόγους θα πρέπει να εξαιρεθούν από κάθε VCS, δεδομένου ότι περιέχουν τα προσωρινά αρχεία.
Συμβουλευτείτε την τεκμηρίωση διάταξη σε doc / wiki / layout.md για περισσότερες πληροφορίες σχετικά με τους ρόλους των διαφόρων υποκαταλόγους

Απαιτήσεις :.

• Python
• pip
• rsync