hỗ trợ công cụ tái cấu trúc


128

Tôi là một fan hâm mộ lớn của reSturationuredText , tuy nhiên các công cụ hỗ trợ nó nằm rải rác trên Internet. Các danh sách công cụ chính thức là không đầy đủ và / hoặc lỗi thời, và có thể được cập nhật chỉ thông qua cam kết ưu đãi. Đôi khi, có một danh sách toàn diện tại trang Wikipedia tái cấu trúc Wikipedia , nhưng điều này rõ ràng " không đáp ứng được hướng dẫn đáng chú ý cho nội dung web " và đã bị xóa .

Vì vậy, để đặt nó dưới dạng câu hỏi: Người ta có thể mong đợi hỗ trợ công cụ nào khi làm việc với reSturationuredText, ví dụ: trình soạn thảo văn bản, phần mềm Wiki, trình chuyển đổi sang và từ reSturationuredText, v.v.?

Câu trả lời:


440

Cứu hộ (và mở rộng) danh sách từ một phiên bản cũ của trang Wikipedia :

Tài liệu

Triển khai

Mặc dù việc triển khai tham chiếu của reSturationuredText được viết bằng Python, nhưng cũng có các trình phân tích cú pháp reSturationuredText bằng các ngôn ngữ khác.

Python - Docutils

Phân phối chính của reSturationuredText là gói Python Docutils . Nó chứa một số công cụ chuyển đổi:

  • rst2html - từ reSturationuredText sang HTML
  • rst2xml - từ tái cấu trúc thành XML
  • rst2latex - từ tái cấu trúc đến LaTeX
  • rst2odt - từ tài liệu tái cấu trúc đến tài liệu ODF Text (bộ xử lý văn bản).
  • rst2s5 - từ reSturationuredText đến S5 , Hệ thống trình chiếu dựa trên tiêu chuẩn đơn giản
  • rst2man - từ trang tái cấu trúc đến trang Man

Haskell - Pandoc

Pandoc là một thư viện Haskell để chuyển đổi từ định dạng đánh dấu này sang định dạng đánh dấu khác và một công cụ dòng lệnh sử dụng thư viện này. Nó có thể đọc Markdown và (tập hợp con) tái cấu trúc, HTML và LaTeX, và nó có thể viết Markdown, tái cấu trúc, HTML, LaTeX, ConTeXt, PDF, RTF, DocBook XML, OpenDocument XML, ODT, GNU Texinfo, trang và các trình chiếu HTML của S5.

Có một công cụ trực tuyến Pandoc (POT) để thử thư viện này. Thật không may, so với trình kết xuất trực tuyến reSturationuredText (ROR),

  • POT cắt ngắn đầu vào khá sớm. Người dùng POT phải kết xuất đầu vào theo từng khối có thể được ROR hiển thị toàn bộ.
  • Đầu ra POT thiếu các thông báo lỗi hữu ích được hiển thị bởi ROR (và được tạo bởi docutils)

Java - JRst

JRst là một trình phân tích cú pháp tái cấu trúc Java. Hiện tại nó có thể xuất HTML, XHTML, DocBook xdoc và PDF, BUT dường như có vấn đề nghiêm trọng: cả việc tạo PDF hoặc (X) HTML đều không sử dụng tải xuống đầy đủ hiện tại, các trang kết quả trong (X) HTML đều trống và việc tạo PDF không thành công trên IO sự cố với tệp XSL (không được đóng gói ??). Lưu ý rằng JRst ban đầu đã bị xóa khỏi trang web; một ngã ba được tìm thấy trên GitHub .

Scala - Laika

Laika là một thư viện mới để chuyển đổi ngôn ngữ đánh dấu sang các định dạng đầu ra khác. Hiện tại, nó hỗ trợ đầu vào từ Markdown và reSturationuredText và tạo đầu ra HTML. Thư viện được viết bằng Scala nhưng cũng có thể sử dụng được từ Java.

Perl

PHP

  • Gregwar / RST - Trình phân tích cú pháp PHP5.3 trưởng thành với các bài kiểm tra
  • php-tái cấu trúctext - Một triển khai đơn giản, không đầy đủ (nhưng chức năng)

CNET

Nim / C

Các Nim biên dịch các tính năng của các lệnh rst2htmlrst2texchuyển đổi hình thức file reStructuredText sang HTML và các file TeX. Thư viện chuẩn cung cấp các mô-đun sau (được trình biên dịch sử dụng) để xử lý các tệp reSturationuredText theo lập trình:

  • đầu tiên - thực hiện một trình phân tích cú pháp tái cấu trúc
  • rstast - thực hiện AST cho trình phân tích cú pháp reSturationuredText
  • rstgen - thực hiện một trình tạo HTML / latex từ tái cấu trúc

Bộ chuyển đổi bên thứ 3 khác

Hầu hết (nhưng không phải tất cả) các công cụ này đều dựa trên Docutils (xem ở trên) và cung cấp chuyển đổi sang hoặc từ các định dạng có thể không được phân phối chính hỗ trợ.

Từ tái cấu trúc

  • restview - pipGói python có thể cài đặt này yêu cầu docutils, thực hiện kết xuất thực tế. restviewTính năng dễ sử dụng chính của nó là, khi bạn lưu các thay đổi vào (các) tài liệu của mình, nó sẽ tự động hiển thị lại và hiển thị lại chúng.restview
    1. bắt đầu một máy chủ web nhỏ
    2. các cuộc gọi docutilsđể hiển thị (các) tài liệu của bạn sang HTML
    3. gọi trình duyệt của thiết bị của bạn để hiển thị HTML đầu ra.
  • rst2pdf - từ tái cấu trúc thành PDF
  • rst2odp - từ trình bày lại cấu trúc đến bản trình bày ODF
  • rst2beamer - từ lớp tái cấu trúc đến lớp trình bày của trình chiếu LaTeX
  • Wikir - từ các định dạng Wiki tái cấu trúc đến các định dạng Wiki của Google (và có thể khác)
  • rst2qhc - Chuyển đổi một tập hợp các tệp reSturationuredText thành tệp Trợ giúp Qt (bộ công cụ) và (tùy chọn) tệp Dự án Trợ giúp Qt

Để tái cấu trúc

  • xml2rst là một tập lệnh XSLT để chuyển đổi biểu diễn XML bên trong của Docutils (trở lại) thành tái cấu trúc
  • Pandoc (xem ở trên) cũng có thể chuyển đổi từ Markdown, HTML và LaTeX sang tái cấu trúc
  • db2rst là một DocBook đơn giản và giới hạn đối với trình dịch tái cấu trúc
  • pod2rst - chuyển đổi tập tin .pod thành tập tin tái cấu trúc

Tiện ích mở rộng

Một số dự án sử dụng reSturationuredText làm cơ sở để xây dựng hoặc cung cấp chức năng bổ sung mở rộng tiện ích của các công cụ reSturationuredText.

Nhân sư

Trình tạo tài liệu Sphinx chuyển một tập hợp các tệp nguồn tái cấu trúc thành các định dạng đầu ra khác nhau, tự động tạo các tham chiếu chéo, các chỉ mục, v.v.

rest2web

rest2web là một công cụ đơn giản cho phép bạn xây dựng trang web của mình từ một mẫu duy nhất (hoặc nhiều như bạn muốn) và giữ nội dung trong reSturationuredText.

Đồ trang sức

Pygments là một cú pháp tô sáng chung để sử dụng chung trong tất cả các loại phần mềm như hệ thống diễn đàn, Wikis hoặc các ứng dụng khác cần làm đẹp mã nguồn. Xem Sử dụng Pygments trong các tài liệu tái cấu trúc .

Biên tập viên miễn phí

Mặc dù bất kỳ trình soạn thảo văn bản đơn giản nào cũng phù hợp để viết các tài liệu tái cấu trúc, một số trình soạn thảo có hỗ trợ tốt hơn các trình soạn thảo khác.

Emacs

Các hỗ trợ Emacs qua đầu tiên chế độ đến như một phần của gói Docutils dưới/docutils/tools/editors/emacs/rst.el

Vim

Các vim-commongói cho mà đi kèm với hầu hết các bản phân phối GNU / Linux có reStructuredText cú pháp nổi bật và hỗ trợ thụt đầu dòng của reStructuredText out of the box:

Jed

Có một chế độ đầu tiên cho trình soạn thảo lập trình viên Jed .

gedit

gedit, trình soạn thảo văn bản chính thức của môi trường máy tính để bàn Gnome. Có một plugin tái cấu trúc gedit .

Geany

Geany , một Môi trường phát triển tích hợp nhỏ và nhẹ bao gồm hỗ trợ tái cấu trúc lại từ phiên bản 0.12 (ngày 10 tháng 10 năm 2007).

Sư Tử

Leo , một trình soạn thảo phác thảo cho các lập trình viên, hỗ trợ reSturationuredText thông qua các nút rst-plugin hoặc thông qua các nút "@ auto-rst" (không phải là tài liệu tốt, nhưng các nút @ auto-rst cho phép chỉnh sửa trực tiếp các tệp đầu tiên, phân tích cấu trúc vào phác thảo Leo) .

Nó cũng cung cấp một cách để xem trước HTML kết quả, trong khung "viewrendered".

FTE

Trình chỉnh sửa văn bản FTE Folding - trình soạn thảo văn bản miễn phí (được cấp phép theo GNU GPL) cho các nhà phát triển. FTE một chế độ hỗ trợ reStructuredText. Nó cung cấp màu sắc nổi bật của các yếu tố RSTX cơ bản và menu đặc biệt cung cấp cách dễ dàng để chèn các yếu tố RSTX phổ biến nhất vào tài liệu.

Bình

PyK là sự kế thừa của PyEdit và reStInPeace, được viết bằng Python với sự trợ giúp của bộ công cụ Qt4.

Nhật thực

IDE Eclipse với trình cắm thêm ReST Editor cung cấp hỗ trợ để chỉnh sửa các tệp reSturationuredText.

NoTex

NoTex là trình soạn thảo văn bản (mục đích chung) dựa trên trình duyệt, với tính năng quản lý dự án tích hợp và tô sáng cú pháp. Thêm vào đó, nó cho phép viết sách, báo cáo, bài viết, vv bằng cách sử dụng rST và chuyển đổi chúng thành LaTex, PDF hoặc HTML. Các tệp PDF có chất lượng xuất bản cao và được sản xuất thông qua Sphinx với bộ Texlive LaTex.

Notepad ++

Notepad ++ là trình soạn thảo văn bản cho mục đích chung cho Windows. Nó có tô sáng cú pháp cho nhiều ngôn ngữ được tích hợp sẵn và hỗ trợ cho reSturationuredText thông qua một ngôn ngữ do người dùng xác định cho reSturationuredText .

Mã Visual Studio

Visual Studio Code là trình soạn thảo văn bản cho mục đích chung cho Windows / macOS / Linux. Nó có tô sáng cú pháp cho nhiều ngôn ngữ tích hợp và hỗ trợ reSturationuredText thông qua một phần mở rộng từ LeXtudio .

Trình chỉnh sửa tái cấu trúc chuyên dụng

Biên tập viên độc quyền

Văn bản cao siêu

Sublime Text là trình soạn thảo mã nguồn hoàn toàn có thể tùy chỉnh và mở rộng có sẵn cho Windows, OS X và Linux. Đăng ký là cần thiết để sử dụng lâu dài, nhưng tất cả các chức năng có sẵn trong phiên bản chưa đăng ký, với lời nhắc thỉnh thoảng để mua giấy phép. Các phiên bản 23 (hiện đang trong giai đoạn thử nghiệm) hỗ trợ tô sáng cú pháp reSturationuredText theo mặc định và một số plugin có sẵn thông qua Trình quản lý gói Gói để cung cấp đoạn mã và hoàn thành mã, tô sáng cú pháp bổ sung, chuyển đổi sang / từ RST và các định dạng khác và xem trước HTML trong trình duyệt.

BBEdit / TextWrangler

BBEdit (và TextWrangler biến thể miễn phí của nó ) cho Mac có thể đánh dấu cú pháp tái cấu trúc bằng cách sử dụng mô-đun ngôn ngữ không mã hóa này .

TextMate

TextMate , một trình soạn thảo văn bản GUI đa năng độc quyền cho Mac OS X, có một gói để tái cấu trúc .

Intype

Intype là một trình soạn thảo văn bản độc quyền cho Windows, hỗ trợ reSturationuredText ra khỏi hộp.

Trình soạn thảo văn bản

E là Trình soạn thảo văn bản độc quyền được cấp phép theo "Giấy phép công ty mở". Nó hỗ trợ các gói của TextMate, do đó, nó sẽ hỗ trợ tái cấu trúc lại giống như cách TextMate thực hiện.

Kim tự tháp

PyCharm (và các IDE nền tảng IntelliJ khác?) Có hỗ trợ ReST / Sphinx (tô sáng cú pháp, tự động hoàn thành và xem trước). xem trước tức thì)

Wiki

Dưới đây là một số chương trình Wiki hỗ trợ đánh dấu reSturationuredText dưới dạng cú pháp đánh dấu gốc hoặc dưới dạng bổ trợ:

MediaWiki

Phần mở rộng reSt structuredText của MediaWiki cho phép đánh dấu reSturationuredText trong MediaWiki được bao quanh bởi <rst></rst>.

Moininin

MoinMoin là một WikiEngine tiên tiến, dễ sử dụng và có thể mở rộng với cộng đồng người dùng lớn. Nói một vài từ, đó là về sự hợp tác trên các trang web dễ chỉnh sửa.

Có một Trình phân tích lại cấu trúc lại cho MoinMoin .

Trắc

Trac là một wiki nâng cao và hệ thống theo dõi vấn đề cho các dự án phát triển phần mềm. Có một Hỗ trợ tái cấu trúc trong Trac .

Wiki này

Wiki này là một phần mềm web cho Python Wiki được viết bởi Ian Bicking. Wiki này sử dụng ReSturationuredText để đánh dấu.

rstiki

rstiki là một wiki cá nhân một tập tin tối giản sử dụng cú pháp reSturationuredText (thông qua docutils) lấy cảm hứng từ pwyky . Nó không hỗ trợ chỉ định quyền tác giả, phiên bản, phân cấp, chrome / khung / templating hoặc kiểu dáng. Nó sử dụng docutils / reSturationuredText như cú pháp wiki. Như vậy, nó có dưới 200 dòng mã và trong một tệp duy nhất. Bạn đặt nó trong một thư mục và nó chạy.

ikiwiki

Ikiwiki là một trình biên dịch wiki. Nó chuyển đổi các trang wiki thành các trang HTML phù hợp để xuất bản trên một trang web. Ikiwiki lưu trữ các trang và lịch sử trong một hệ thống kiểm soát sửa đổi, chẳng hạn như Subversion hoặc Git. Có nhiều tính năng khác, bao gồm hỗ trợ viết blog, cũng như một loạt các plugin. Đó là reStructuredText Plugin , tuy nhiên có phần hạn chế và không được khuyến cáo như là ngôn ngữ đánh dấu của nó chính vào lúc này.

Dịch vụ web

Hộp cát

Một trình soạn thảo tái cấu trúc trực tuyến có thể được sử dụng để chơi với đánh dấu và xem kết quả ngay lập tức.

Khung blog

WordPress

Phần mềm bổ trợ tái cấu trúc cho chương trình SolitairereSt cho WordPress. (PHP)

Zine

plugin trình phân tích cú pháp reSturationuredText cho Zine (sẽ trở nên lỗi thời trong phiên bản 0.2 khi Zine được lên lịch để nhận hỗ trợ reSturationuredText gốc). Zine bị ngưng. (Con trăn)

Bồ nông

Pelican là một trình tạo blog tĩnh hỗ trợ viết bài trong ReST. (Con trăn)

hyde

Hyde là một trình tạo trang web tĩnh hỗ trợ ReST. (Con trăn)

Acrylamid

Acrylamid là một trình tạo blog tĩnh hỗ trợ viết bài trong ReST. (Con trăn)

Nikola

Nikola là một trang web tĩnh và Trình tạo blog hỗ trợ ReST. (Con trăn)

chi ipsum

Ipsum chi là một trình tạo blog tĩnh được viết bằng Nim.

Yozuch

Yozuch là một trình tạo blog tĩnh được viết bằng Python.

Hơn


Đối với PHP, gói Tài liệu của Thành phần Zeta có hỗ trợ tái cấu trúc tốt.
Rob Allen

Bạn cũng có thể quan tâm đến việc xem trước trực tiếp , giống như những gì Markedapp đang cung cấp cho các tài liệu Markdown. Nó không phải là một công cụ reSturationredText, nhưng tôi thấy nó thực sự hữu ích.
Wilfred Springer

1
Qua Nhận xét của Amy Brown , tôi được biết bạn có thể thiết lập Marked.app để hiển thị đầu tiên bằng cách vào tùy chọn> hành vi, bật "Bộ xử lý Markdown tùy chỉnh" và trỏ nó vào tệp rst2html.py.
Shon

Thời gian sẽ làm cho câu trả lời này cũng lỗi thời. Tôi đã kiểm tra chỉ một vài gợi ý, như PYK và RIP, không thể chạy trên các hệ thống ngày nay vì chúng phụ thuộc vào các mô-đun lỗi thời, vì vậy ...
theta

3
Tôi đã thêm liên kết đến vim addon Riv.vim, với tôi cung cấp những gì tôi đang tìm kiếm trong thời gian dài. github.com/Rykka/riv.vim
Jan Vlcinsky
Khi sử dụng trang web của chúng tôi, bạn xác nhận rằng bạn đã đọc và hiểu Chính sách cookieChính sách bảo mật của chúng tôi.
Licensed under cc by-sa 3.0 with attribution required.