markdown2Mathjax

markdown2Mathjax là một gói phần mềm đơn giản cho phép bạn sử dụng phong cách latex toán được tạo ra bởi MathJax kết hợp với các định dạng markdown phổ biến & nbsp;. Có hai hiện thực của markdown trong python, gói này được thiết kế để được sử dụng với sự sử dụng rộng rãi hơn và tích cực duy trì trong hai người, gọi là markdown2. Điển hình sử dụng như sau:
#! / Usr / bin / env python
từ markdown2Mathjax nhập sanitizeInput, reconstructMath
từ markdown2 markdown nhập khẩu
tmp = sanitizeInput (sometxt)
markdedDownText = markdown (tmp [0])
finalOutput = reconstructMath (markedDownText, tmp [1])
(Nơi "sometxt" là một chuỗi chứa markdown + mathjax văn bản.)
Cài đặt
markdown2Mathjax được lưu trữ trên pypi, vì vậy có thể được cài đặt hoặc từ nguồn, sử dụng:
tar zxvf markdown2Mathjax-x.x.x.tar.gz
cd markdown2Mathjax-x.x.x
python setup.py cài đặt
hoặc sử dụng pip (hoặc easy_install nếu bạn muốn):
pips cài đặt markdown2Mathjax
Cách sử dụng
Theo mặc định, toán được đánh dấu bằng dấu hiệu $ duy nhất cho môn toán nội tuyến và dấu hiệu $$ đôi cho phương trình. Tuy nhiên, bất kỳ dây khoanh vùng có thể được sử dụng bằng cách thay đổi các đối số từ khóa để các chức năng sanitizeInput và reconstructMath. Lưu ý rằng mặc mathjax KHÔNG sử dụng đô la dấu hiệu duy nhất để phân định toán nội tuyến, vì vậy nếu bạn sử dụng các giá trị mặc định cho các gói này, bạn sẽ phải hướng dẫn mathjax để xử lý nó một cách thích hợp.
Giải
Các chức năng sanitizeInput tìm thấy bất kỳ trường hợp của toán học (như được xác định bởi các ký tự phân cách cung cấp) và thay thế chúng bằng một trình giữ chỗ. Giữ chỗ này có thể được xác định bởi người sử dụng, nhưng nó được khuyến khích bạn sử dụng mặc định được cung cấp của "$ 0 $". Giữ chỗ có được một cái gì đó sẽ không được xử lý bởi markdown, và sẽ không bao giờ được sản xuất bởi markdown. Việc đầu tiên của các yêu cầu này là dễ dàng, đủ để đáp ứng, thứ hai có thể được một chút tinh tế hơn. Nếu giữ chỗ đã tồn tại trong văn bản người dùng cung cấp, nó được ghi nhận bởi sanitizeInput và sẽ bị bỏ lại một mình khi tái toán sau khi chế biến markdown.
Mỗi lần một khối toán hợp lệ là gặp phải và thay thế bằng một trình giữ chỗ, các môn toán được lưu trong một danh sách (được gọi là CodeBlocks) mà sau đó được trả về bởi hàm sanitizeInput. Mỗi mục trong CodeBlocks được bắt đầu bằng hoặc là 0 (cho một sự xuất hiện đen của placeholder trong văn bản), 1 cho toán inline hoặc 2 cho một phương trình riêng biệt.
Chuỗi vệ sinh từ sanitizeInput sau đó có thể được đánh dấu bởi markdown mà không sợ toán học của bạn được đọc sai. Cuối cùng, reconstructMath thay thế từng giữ chỗ trong văn bản được đánh dấu với các codeblock thích hợp. Html thức này sau đó có thể được hiển thị với mathjax thích hợp javascript tiêu đề.
Một cách khác để suy nghĩ về việc này là hơn reconstructMath về cơ bản là nghịch đảo của sanitizeInput. Vì vậy, mà không sử dụng markdown ở giữa, không có gì nên thay đổi giữa hai (trừ khi reconstructMath cũng làm một số ngẫu thêm của CodeBlocks toán). Đó là:
tmp = sanitizeInput (thử nghiệm)
reconstructMath (tmp [0], tmp [1]) == kiểm tra
phải luôn luôn đánh giá đúng

Yêu cầu .

• Python