redtape

redtape là một máy phát tài liệu tập trung có sử dụng github markdown hương vị để tạo ra đơn giản, tài liệu HTML hấp dẫn. Nó sẽ tự động tích hợp với twitter bootstrap và các tính năng đơn giản, kiểu dáng hấp dẫn. redtape được lấy cảm hứng từ d, nhưng cố gắng để có một giao diện đơn giản, trong khi vẫn cho phép người sử dụng để tạo kiểu và kiểm soát các tài liệu đầu ra của họ đến một mức độ cao của khách hàng.
Cài đặt
Nếu bạn đang trên Linux hoặc OSX, bạn có thể sử dụng pip để cài đặt:
> Pips cài đặt redtape
Mà sẽ cài đặt redtape và phụ thuộc của nó.
Cách sử dụng
Để sử dụng, chạy rt trên một tài liệu hoặc thư mục đầy đủ các văn bản. Nếu chạy trên một thư mục, rt sẽ tạo ra file html cho mỗi tập tin markdown (.md, .mdown, hoặc mở rộng .markdown):
> Rt mydocument.md
> Tài liệu rt /
tài
Theo mặc định, rt giả sử bạn đã thiết lập một vị trí để phục vụ các tập tin mà từ đó có các tài sản mà RT liên kết vào các tài liệu này. Bố trí là chính xác giống như các thư mục tài sản trong kho redtape: / tài sản / {css, img, js} / .. cho từng tài sản mà bạn sẽ sử dụng. Nếu bạn muốn sử dụng tài sản mặc định redtape, bạn có thể dễ dàng tạo ra một thư mục tài sản phù hợp trong thư mục hiện tại bằng cách chạy:
> Rt --Tạo-tài sản
Nếu bạn đang chạy trong chế độ tài liệu duy nhất hoặc không muốn thiết lập một thư mục trên máy chủ tài sản cuối cùng cho tài liệu HTML của bạn, bạn có thể nói redtape để nhúng từng tài sản được sử dụng trong một tài liệu bằng cách sử dụng --embed:
> Rt --embed mydocument.md
javascript
Theo mặc định, redtape không yêu cầu bất kỳ javascript để chạy, và sẽ không nhúng bất kỳ trong chế độ --embed. Nếu tùy chọn --prettify được chọn, tô điểm thư viện của google sẽ được sử dụng để làm nổi bật nguồn thay vì pygments, và nếu --prettify và --embed đều được sử dụng, nó sẽ được tự động nhúng.
Redtape cũng thích hợp cho một trang trình diễn javascript đơn giản, và nếu --use-js được kích hoạt, sẽ bao gồm redtape jquery và thư viện javascript bootstrap của.
tùy biến đầu ra
Tùy biến đầu ra là dễ dàng để làm theo nhiều cách khác nhau. Bên cạnh việc thay đổi CSS tài sản cho các tài liệu không được nhúng, bạn cũng có thể thêm tiêu đề và cuối trang hoặc thậm chí sử dụng các mẫu văn bản tùy chỉnh dựa trên mẫu mặc định của redtape.
tiêu đề và cuối trang
Nếu bạn có một tiêu đề tài liệu tùy chỉnh hoặc chân trang bạn muốn thêm vào tài liệu của bạn, bạn có thể thêm header.html và footer.html tài liệu vào thư mục cơ sở bạn là rendering hoặc thiết lập đường dẫn mặc định sẽ được sử dụng trong cấu hình như header và footer. Theo mặc định, chúng sẽ được đặt ở trên cùng và dưới cùng của tài liệu của bạn, tương ứng.
Một bộ mẫu các văn bản có thể là:
> Ls MyDocs /
MyDocs / index.md MyDocs / simple.md MyDocs / advanced.md
MyDocs / header.html MyDocs / footer.html
MyDocs rendering với MyDocs rt sẽ sử dụng các header và footer cho từng tài liệu trong các thư mục.
các mẫu tùy chỉnh
Nếu bạn có yêu cầu rất cụ thể, bạn có thể viết mẫu tài liệu của mình và có toàn quyền kiểm soát của đầu ra. Redtape sử dụng cỗ máy template jinja2, mà là một hệ thống khuôn mẫu tương tự như sử dụng rộng rãi để django mẫu. Chạy redtape với lập luận --context để có được một ý tưởng ngắn gọn về những gì các biến có sẵn cho mẫu.
Bạn cũng có thể kế thừa từ basic.jinja, đó là tên của template mặc định của redtape. Mẫu này định nghĩa hai khối, đầu và cơ thể, mà sẽ cho phép bạn soạn thảo một tài liệu trong khi cơ thể riêng biệt, ví dụ, giữ lại CSS cơ bản và chức năng JavaScript của redtape. Trọng cả sẽ để lại cho bạn một cấu trúc tài liệu HTML5 tiêu chuẩn.
Bạn có thể chỉ định một mẫu tuỳ chỉnh để sử dụng với -t, --template hoặc đặt nó trong thư mục tài liệu như custom.html hoặc custom.jinja

Yêu cầu .

• Python