Markdoc

Markdoc là hướng tới việc quản lý tài liệu kỹ thuật, nhưng có thể được sử dụng cho nhiều mục đích. Markdoc có một vài điểm bán hàng đáng chú ý:
* Wikis được tạo thành hoàn toàn của file văn bản thô, vì vậy bạn có thể dễ dàng đặt chúng dưới sự kiểm soát phiên bản.
* Wikis biên dịch thành các thư mục HTML độc, có thể được phân phối như tarball hoặc phục vụ bởi một máy chủ HTTP.
* Bạn có thể tùy chọn bao gồm phương tiện truyền thông tĩnh mà sẽ được biên dịch vào các thư mục HTML cùng với tất cả các trang kết xuất của bạn.
* Markdoc đi kèm với một ứng dụng và máy chủ HTTP thuần Python WSGI đầy đủ chức năng phục vụ lên wiki biên soạn.
* Bạn có thể khiến wiki của bạn với một loạt các phần mở rộng Markdown, chẳng hạn như mã tô sáng Pygments dựa trên cú pháp mở rộng cho các danh sách định nghĩa, thế hệ TOC, vân vân.
* Bạn hoàn toàn có thể tùy chỉnh cách wiki của bạn được trả lại bằng cách chỉnh sửa các mẫu Jinja2 sử dụng để chuyển đổi rendered Markdown vào tài liệu HTML đầy đủ.
Quickstart
Cài đặt:
#! / Bin / bash
hg bản sao ssh: //hg@bitbucket.org/zacharyvoase/markdoc
cd markdoc /
pips cài đặt YÊU CẦU -r
python setup.py cài đặt
Làm một Wiki
#! / Bin / bash
markdoc init my-wiki
cd my-wiki /
vim wiki / somefile.md
# ... Viết một số tài liệu ...
markdoc xây dựng
markdoc phục vụ
# .. Mở http: // localhost: 8008 / trong một trình duyệt ...
Layout
Wiki Markdoc có cách bố trí mặc định sau đây:
WIKI_ROOT /
| - .html /
| - .templates /
| - .tmp /
| - Tĩnh /
| - Wiki /
`- Markdoc.yaml
.html / Và .tmp / thư mục này có thể được loại trừ khỏi bất kỳ VCS, vì chúng có chứa các tập tin tạm thời.
Tham khảo tài liệu bố trí trong doc / wiki / layout.md để biết thêm thông tin về vai trò của các thư mục con khác nhau

Yêu cầu .

• Python
• pip
• rsync