Markowik là một ứng dụng Python có thể chuyển đổi định dạng văn bản Markdown để Google Code Wiki.
Markowik có thể chuyển đổi hầu hết các cấu trúc Markdown để Google Code Wiki (GCW) tương đương của nó. Thay vì liệt kê tất cả các chuyển đổi được hỗ trợ, vui lòng có một cái nhìn tại phòng thử nghiệm Markowik và trường hợp hiển thị của nó.
Cài đặt
Chạy:
pips cài đặt markowik
hoặc:
easy_install markowik
Bạn cũng có thể sử dụng mà không cần cài đặt Markowik, như được mô tả dưới Góp phần.
Command Line Cách sử dụng
Từ đầu ra giúp đỡ:
cách sử dụng: markowik [h] [--mx [MX [MX ...]]] [--image-baseurl URL]
& Nbsp; [- html-hình ảnh] [--encoding Mã hóa] [--quiet]
& Nbsp; INFILE [OUTFILE]
Chuyển đổi Markdown để Google Code Wiki.
đối số vị trí:
& Nbsp; INFILE tập markdown
& Nbsp; OUTFILE tập tin wiki (mặc định: stdout)
đối số tùy chọn:
& Nbsp; -h, --help hiển thị thông báo và thoát ra trợ giúp này
& Nbsp; - mx [MX [MX ...]] mở rộng markdown để kích hoạt
& Nbsp; - URL cơ sở URL hình ảnh baseurl để thêm vào trước các vị trí hình ảnh tương đối
& Nbsp; - html-hình ảnh luôn luôn sử dụng HTML cho hình ảnh
& Nbsp; - mã hóa mã hóa Mã hóa các đầu vào và đầu ra (mặc định: UTF8)
& Nbsp; - thông tin disable yên tĩnh
Mở rộng Markdown có thể được tương tự như các công cụ dòng lệnh Python Markdown (PyMD), với ngoại lệ là phần mở rộng của cá nhân phải được ngăn cách bởi một không gian:
markowik bảng Input --mx def_list
Các hỗ trợ hiện tại (tức là thử nghiệm) phần mở rộng là viết tắt, bảng và def_list. Phần mở rộng khác thường nên làm việc quá nhưng có thể đem lại kết quả bất ngờ trong các văn bản wiki chuyển đổi.
Liên quan đến việc lựa chọn --html-hình ảnh, xem giải thích bên dưới tại hạn chế.
Cách sử dụng chương trình đối
Markowik được thực hiện trong Python. Các mô-đun markowik cung cấp một chức năng có tên convert. Ngữ nghĩa nó là tương tự như giao diện dòng lệnh (đối số từ khóa tương ứng với lệnh tùy chọn dòng). Đây là một cách sử dụng ví dụ nhỏ:
>>> Nhập markowik
>>> Markowik.convert ("Một số văn bản * * markdown ...", mx = ['bảng'])
u'Some _markdown_ văn bản ... '
Trang pragmas
GCW pragmas trang có thể được thiết lập trong Markdown file nguồn như là dữ liệu meta trong các định dạng được định nghĩa bởi phần mở rộng meta PyMD:
>>> Src = "" "Tóm tắt: tóm tắt trang
... Labels: một số, nhãn
...
... Ở đây bắt đầu trang * * ..
... "" "
>>> Print markowik.convert (src, mx = ['siêu'])
tóm tắt trang #summary
#labels số, nhãn
Đây bắt đầu _page_ ..
Lưu ý rằng phần mở rộng meta phải được kích hoạt một cách rõ ràng, tức là theo mặc định Markowik không nhận pragmas trang
là gì mới trong phiên bản này:.
< ul>
là gì mới trong phiên bản 0.1.1:.
- Cải thiện tài liệu
- sửa chữa nhỏ.
Yêu cầu :
- Python
Hạn chế :
- GCW có thể không thể hiện tất cả các đánh dấu có thể trong Markdown. Điều này có nghĩa các tập tin nguồn Markdown nên được viết với những hạn chế sau đây trong tâm trí.
- URL trong kết và hình ảnh:
- URL được sử dụng cho các liên kết hoặc các nguồn hình ảnh phải là tuyệt đối và phải có một giao thức cụ thể để có được công nhận bởi GCW. Đặc biệt, bất kỳ URL phải bắt đầu bằng http: //, https: // hoặc ftp: //. Markowik hủy bỏ việc chuyển đổi nếu nó tìm thấy URL không phù hợp với các yêu cầu này.
- Typefacing trong Link Names:
- GCW không hỗ trợ typefacing trong tên link. Ví dụ GCW ám tên liên kết trong [http://foo.com _Foo_] theo nghĩa đen, tức là _Foo_. Tuy nhiên, GCW nhận typefacing trong các liên kết HTML, tức là & lt; a href = & quot; http: //foo.com" & Gt; & lt _Foo_; / A & gt; được nhấn mạnh đúng. Vì lý do này liên kết với Markdown typefacing lồng nhau như [* Foo *] (http://foo.com) sẽ được chuyển đổi sang các liên kết HTML. Kết quả là, nhãn liên kết với một số ký tự đặc biệt mà phải được chạy thoát trong GCW sử dụng backtick (`) đánh dấu cũng sẽ cho kết quả trong các liên kết HTML.
- Nested đoạn văn:
- GCW không thực sự hỗ trợ nhiều đoạn lồng nhau (ví dụ như trong danh sách hoặc blockquotes). Markowik mô phỏng nhiều đoạn lồng nhau bằng cách tách chúng bằng & lt; br / & gt; (Mà trực quan bắt chước đoạn nhưng không phá vỡ môi trường làm tổ).
- Hình ảnh:
- Markdown cho phép thể hiện các văn bản thay thế và tiêu đề cho hình ảnh. Cú pháp hình ảnh của GCW không hỗ trợ này. Cách duy nhất để bảo tồn những văn bản này là sử dụng HTML đồng bằng & lt; img & gt; tags. Các tùy chọn --html-hình ảnh cho phép áp dụng cách này.
- Một vấn đề khác là GCW mong URL hình ảnh để kết thúc với một phần mở rộng loại tập tin hình ảnh. Markowik thêm phần mở rộng hình ảnh nhân tạo nếu cần thiết, ví dụ http://foo.bar/image được thay đổi để http://foo.bar/image?x=x.png.
- Chữ viết tắt:
- GCW không có đánh dấu cho chữ viết tắt cũng không hỗ trợ thẻ HTML & lt; abbr & gt ;. Markowik chuyển đổi chữ viết tắt cho & lt; span & gt; -elements mà loại bắt chước chữ viết tắt (trong một giới hạn thời trang của khóa học) .
- HTML:
- Bất kỳ HTML đơn giản xảy ra trong một nguồn Markdown kết thúc nghĩa đen trong GCW (với ngoại lệ của nội dung của các thẻ khoảng cấp). Điều này có nghĩa các nguồn Markdown chỉ nên chứa HTML được hỗ trợ bởi GCW. Hàm ý khác là các URL được sử dụng trong các thẻ HTML đơn giản không được kiểm tra khả năng tương thích GCW. Nói cách khác: khi sử dụng HTML liệu bạn đang ở trên của riêng bạn !
Bình luận không