reStructuredText aracı desteği


128

Ben reStructuredText'in büyük bir hayranıyım , ancak onu destekleyen araçlar İnternet'in her yerine dağılmış durumda. Resmi aracı liste eksik ve / veya modası geçmiş ve sadece ayrıcalıkları taahhüt yoluyla güncellenebilir. Bir süredir Wikipedia reStructuredText sayfasında kapsamlı bir liste vardı , ancak bu, görünüşe göre " web içeriği için dikkate değerlik kılavuzunu karşılamadı " ve kaldırıldı .

Öyleyse bir soru formuna koymak gerekirse: reStructuredText ile çalışırken hangi araç desteğini bulmayı bekleyebilirsiniz, örneğin metin editörleri, Wiki yazılımı, dönüştürücüler reStructuredText vb.

Yanıtlar:


440

Listeyi Wikipedia sayfasının eski bir sürümünden kurtarmak (ve genişletmek) :

belgeleme

Uygulamalar

ReStructuredText'in referans uygulaması Python'da yazılsa da, diğer dillerde de reStructuredText ayrıştırıcıları vardır.

Python - Belgeler

ReStructuredText'in ana dağıtımı Python Docutils paketidir. Birkaç dönüştürme aracı içerir:

  • rst2html - reStructuredText'ten HTML'ye
  • rst2xml - reStructuredText'ten XML'e
  • rst2latex - reStructuredText ila LaTeX
  • rst2odt - reStructuredText'ten ODF Text (kelime işlemci) belgesine.
  • rst2s5 - reStructuredText ila S5 , Basit Standartlara dayalı Slayt Gösterisi Sistemi
  • rst2man - reStructuredText'ten Man sayfasına

Haskell - Pandoc

Pandoc , bir biçimlendirme biçiminden diğerine dönüştürmek için bir Haskell kitaplığı ve bu kitaplığı kullanan bir komut satırı aracıdır. Markdown ve reStructuredText, HTML ve LaTeX'in (alt kümelerini) okuyabilir ve Markdown, reStructuredText, HTML, LaTeX, ConTeXt, PDF, RTF, DocBook XML, OpenDocument XML, ODT, GNU Texinfo, MediaWiki işaretlemesi, groff man yazabilir sayfaları ve S5 HTML slayt gösterileri.

Bu kitaplığı denemek için bir Pandoc çevrimiçi aracı (POT) var. Ne yazık ki, reStructuredText çevrimiçi oluşturucu (ROR) ile karşılaştırıldığında,

  • POT, girişi daha kısa sürede keser. POT kullanıcısı, ROR tarafından tam olarak işlenebilen girdiler halinde girdiler oluşturmalıdır.
  • POT çıktısı, ROR tarafından görüntülenen (ve tarafından oluşturulan docutils) yardımcı hata mesajlarından yoksundur.

Java - JRst

JRst, bir Java reStructuredText ayrıştırıcısıdır. Şu anda HTML, XHTML, DocBook xdoc ve PDF çıktısı alabiliyor, ANCAK ciddi sorunlar var gibi görünüyor: ne PDF ne de (X) HTML oluşturma mevcut tam indirmeyi kullanarak çalışıyor, (X) HTML'deki sonuç sayfaları boş ve GÇ'de PDF oluşturma başarısız oluyor XSL dosyalarıyla ilgili sorunlar (paketlenmemiş mi?). Orijinal JRst'in web sitesinden kaldırıldığını unutmayın ; GitHub'da bir çatal bulunur .

Scala - Laika

Laika , biçimlendirme dillerini diğer çıktı biçimlerine dönüştürmek için yeni bir kitaplıktır. Şu anda Markdown ve reStructuredText'ten gelen girdileri destekliyor ve HTML çıktısı üretiyor. Kitaplık Scala'da yazılmıştır, ancak Java'dan da kullanılabilir olmalıdır.

Perl

PHP

C # /. NET

Nim / C

Nim derleyici komutları özellikleri rst2html ve rst2texHTML hem TeX dosyaları reStructuredText dosyaları dönüştürmek. Standart kitaplık, reStructuredText dosyalarını programla işlemek için aşağıdaki modülleri (derleyici tarafından kullanılan) sağlar:

  • rst - reStructuredText ayrıştırıcıyı uygular
  • rstast - reStructuredText ayrıştırıcısı için bir AST uygular
  • rstgen - reStructuredText'ten bir HTML / Lateks oluşturucu uygular

Diğer 3. taraf dönüştürücüler

Bu araçların çoğu (ama hepsi değil) Docutils'e dayanmaktadır (yukarıya bakın) ve ana dağıtım tarafından desteklenmeyen formatlara veya formatlardan dönüştürme sağlar.

ReStructuredText'ten

  • restview - Bu kurulabilirpip python paketi docutils, gerçek oluşturmayı yapan gerektirir . restview'nin başlıca kullanım kolaylığı özelliği, belgelerinizdeki değişiklikleri kaydettiğinizde, bunları otomatik olarak yeniden işleyip yeniden görüntülemesidir.restview
    1. küçük bir web sunucusu başlatır
    2. docutilsbelgelerinizi HTML'ye dönüştürme çağrıları
    3. çıktı HTML'yi görüntülemek için cihazınızın tarayıcısını çağırır.
  • rst2pdf - reStructuredText'ten PDF'ye
  • rst2odp - reStructuredText'ten ODF Sunumuna
  • rst2beamer - reStructuredText'ten LaTeX beamer Presentation sınıfına
  • Wikir - reStructuredText'ten Google (ve muhtemelen diğer) Wiki biçimlerine
  • rst2qhc - reStructuredText dosyalarının bir koleksiyonunu bir Qt (araç seti) Yardım dosyasına ve (isteğe bağlı) bir Qt Yardım Projesi dosyasına dönüştürün

ReStructuredText için

  • xml2rst , Docutils dahili XML temsilini (geri) reStructuredText'e dönüştürmek için bir XSLT betiğidir
  • Pandoc (yukarıya bakın) ayrıca Markdown, HTML ve LaTeX'ten reStructuredText'e dönüştürebilir.
  • db2rst basit ve sınırlı bir DocBook'tan reStructuredText çeviriciye dönüştürülür
  • pod2rst - .pod dosyalarını reStructuredText dosyalarına dönüştürün

Uzantıları

Bazı projeler reStructuredText'i temel olarak kullanır veya reStructuredText araçlarının kullanımını genişleten ekstra işlevsellik sağlar.

Sfenks

Sfenks belgeleri jeneratör otomatik olarak endeksler vb çapraz referanslar üreten, çeşitli çıkış biçimleri içine reStructuredText kaynak dosyaları kümesi çevirir

rest2web

rest2web , web sitenizi tek bir şablondan (veya istediğiniz kadar) oluşturmanıza ve içeriği reStructuredText'te tutmanıza olanak tanıyan basit bir araçtır.

Pygments

Pygments , forum sistemleri, Wiki'ler veya kaynak kodunu güzelleştirmesi gereken diğer uygulamalar gibi her türlü yazılımda genel kullanım için genel bir sözdizimi vurgulayıcıdır. Bkz . ReStructuredText belgelerinde Pygments kullanma .

Ücretsiz Editörler

Herhangi bir düz metin düzenleyici reStructuredText belgelerini yazmak için uygun olsa da , bazı editörler diğerlerinden daha iyi desteğe sahiptir.

Emacs

Emacs desteği ilk-mode üzerinden Docutils paketin parçası olarak altında gelir/docutils/tools/editors/emacs/rst.el

gayret

vim-commonBunun için paket çoğu GNU / Linux dağıtımlarında ile gelir reStructuredText sözdizimi vurgulama ve kutunun dışında reStructuredText ait girinti desteği vardır:

Jed

Bir yoktur ilk mod için Jed programcılar editörü.

gedit

gedit, GNOME masaüstü ortamının resmi metin düzenleyicisi. Bir gedit reStructuredText eklentisi var .

Geany

Küçük ve hafif bir Entegre Geliştirme Ortamı olan Geany , 0.12 (10 Ekim 2007) sürümünden itibaren reStructuredText desteği içerir .

Aslan burcu

Programcılar için bir taslak düzenleyici olan Leo , reStructuredText'i rst-plugin veya "@ auto-rst" düğümleri aracılığıyla destekler (iyi belgelenmemiştir, ancak @ auto-rst düğümleri ilk dosyaları doğrudan düzenlemeye izin vererek yapıyı Leo taslağına ayrıştırır) .

Ayrıca, elde edilen HTML'yi "görüntülenen" bölmede önizlemek için bir yol sağlar.

FTE

FTE Katlama Metin Düzenleyici - ücretsiz (GNU GPL lisanslı) geliştiriciler için metin editörü. FTE , reStructuredText desteği için bir moda sahiptir . Temel RSTX öğelerinin renk vurgulamasını ve bir belgeye en popüler RSTX öğelerini eklemenin kolay yolunu sağlayan özel menüyü sağlar.

PYK

PyK , Qt4 araç setinin yardımıyla Python'da yazılan PyEdit ve reStInPeace'in halefidir.

Eclipse

ReST Editor eklentisine sahip Eclipse IDE, reStructuredText dosyalarını düzenlemek için destek sağlar.

NoTex

NoTex , entegre proje yönetimi ve sözdizimi vurgulamalı, tarayıcı tabanlı (genel amaçlı) bir metin editörüdür. Ayrıca rST kullanarak kitap, rapor, makale vb. Yazmayı ve bunları LaTex, PDF veya HTML'ye dönüştürmeyi sağlar. PDF dosyaları yüksek yayın kalitesine sahiptir ve Texlive LaTex paketi ile Sphinx aracılığıyla üretilir.

Notepad ++

Notepad ++ , Windows için genel amaçlı bir metin düzenleyicisidir. Yerleşik birçok dil için sözdizimi vurgulamasına ve reStructuredText için kullanıcı tanımlı bir dil aracılığıyla reStructuredText desteğine sahiptir .

Visual Studio Kodu

Visual Studio Code , Windows / macOS / Linux için genel amaçlı bir metin düzenleyicidir. Bu yoluyla yerleşik reStructuredText ve destekler çok dil için sözdizimi vurgulama vardır bir uzantısı gelen LeXtudio .

Özel Yeniden Yapılandırılmış Metin Düzenleyicileri

Tescilli editörler

Yüce metin

Sublime Text , Windows, OS X ve Linux için kullanılabilen, tamamen özelleştirilebilir ve genişletilebilir bir kaynak kodu editörüdür. Uzun süreli kullanım için kayıt gereklidir, ancak tüm işlevler kayıtsız sürümde mevcuttur ve ara sıra bir lisans satın almanız için hatırlatma yapılır. Sürüm 2 ve 3 (şu anda beta sürümde), reStructuredText sözdizimi vurgulamayı varsayılan olarak destekler ve snippet'ler ve kod tamamlama, ek sözdizimi vurgulama, RST ve diğer biçimlere / RST'den / RST'ye dönüştürme ve HTML önizlemesi sağlamak için paket yöneticisi Paket Kontrolü aracılığıyla birkaç eklenti kullanılabilir tarayıcıda.

BBEdit / TextWrangler

Mac için BBEdit (ve ücretsiz sürümü TextWrangler ), bu kodsuz dil modülünü kullanarak reStructuredText'i sözdiziminde vurgulayabilir .

TextMate

Mac OS X için tescilli bir genel amaçlı GUI metin editörü olan TextMate , reStructuredText için bir pakete sahiptir .

INTYPE

Intype , reStructuredText'i kutudan çıkar çıkmaz destekleyen Windows için tescilli bir metin editörüdür.

E Metin Düzenleyici

E , "Açık Şirket Lisansı" altında lisanslanan tescilli bir Metin Düzenleyicidir. TextMate'in paketlerini destekler, bu nedenle reStructuredText'i TextMate'in yaptığı gibi desteklemelidir.

pycharm

PyCharm (ve diğer IntelliJ platform IDE'leri?) ReST / Sphinx desteğine sahiptir (sözdizimi vurgulama, otomatik tamamlama ve önizleme). anında önizleme)

wiki

reStructuredText işaretlemesini yerel işaretleme sözdizimi veya bir eklenti olarak destekleyen bazı Wiki programları şunlardır:

MediaWiki

MediaWiki reStructuredText uzantısı , MediaWiki'de<rst> ve ile çevrili reStructuredText işaretlemesine izin verir </rst>.

MoinMoin

MoinMoin, geniş bir kullanıcı topluluğuna sahip gelişmiş, kullanımı kolay ve genişletilebilir bir WikiEngine'dir. Birkaç kelimeyle söylenen, kolayca düzenlenebilir web sayfalarında işbirliği ile ilgilidir.

Bir yoktur MoinMoin için reStructuredText Ayrıştırıcı .

Trac

Trac, yazılım geliştirme projeleri için geliştirilmiş bir wiki ve sorun izleme sistemidir. Bir yoktur Trac reStructuredText Destek .

Bu Wiki

Bu Wiki , Ian Bicking tarafından yazılmış bir Python Wiki Web Yazılımıdır. Bu wiki, biçimlendirmesi için ReStructuredText'i kullanır.

rstiki

rstiki , pwyky'den esinlenerek reStructuredText sözdizimini (docutils aracılığıyla) kullanan minimalist tek dosyalı bir kişisel wikidir . Yazarlık göstergesini, sürüm oluşturmayı, hiyerarşiyi, krom / çerçeveleme / şablon oluşturmayı veya stili desteklemez. Wiki sözdizimi olarak docutils / reStructuredText'ten yararlanır. Bu nedenle, 200 satır kodun altında ve tek bir dosyadadır. Bir dizine koyarsınız ve çalışır.

ikiwiki

İkiwiki bir wiki derleyicisidir. Wiki sayfalarını bir web sitesinde yayınlanmaya uygun HTML sayfalarına dönüştürür. İkiwiki, sayfaları ve geçmişi Subversion veya Git gibi bir revizyon kontrol sisteminde depolar. Blog desteği ve geniş bir eklenti dizisi dahil olmak üzere birçok başka özellik vardır. Bu reStructuredText eklentisi , ancak biraz sınırlıdır ve şu anda ana biçimlendirme dili olarak önerilmemektedir.

Ağ hizmetleri

Kum havuzu

İşaretlemeyle oynamak ve sonuçları hemen görmek için bir Çevrimiçi reStructuredText düzenleyici kullanılabilir.

Blog çerçeveleri

WordPress

WordPress için WordPreSt reStructuredText eklentisi . (PHP)

Zine

Zine için reStructuredText ayrıştırıcı eklentisi (Zine yerel bir reStructuredText desteği almak üzere planlandığında sürüm 0.2'de geçersiz hale gelecektir). Zine üretilmiyor. (Python)

pelikan

Pelican , ReST'de makale yazmayı destekleyen statik bir blog üreticisidir. (Python)

hyde

Hyde , ReST'yi destekleyen statik bir web sitesi üreticisidir. (Python)

akrilamid

Akrilamid dayanakları makaleleri yazmaya olduğunu statik bir blog jeneratör. (Python)

Nikola

Nikola , ReST'yi destekleyen bir Statik Site ve Blog Oluşturucu'dur. (Python)

ipsum cinsi

Ipsum genera , Nim'de yazılmış statik bir blog üreticisidir.

Yozuch

Yozuch , Python ile yazılmış statik bir blog üreticisidir.

Daha


PHP için, Zeta Components'ın Belge paketi iyi bir reStructuredText desteğine sahiptir.
Rob Allen

Markedapp'ın Markdown belgeleri için sunduğu gibi canlı önizlemeye de sahip olmak ilginizi çekebilir . Bu bir reStructredText aracı değil, ama gerçekten yararlı buluyorum.
Wilfred Springer

1
Via Amy Brown'ın Comment , sana "özel Markdown İşlemci" sağlayan tercihleri> davranışa, giderek ve bir rst2html.py dosyasına işaret ederek ilk işlemek için Marked.app ayarlayabilirsiniz öğrendik.
Shon

Zaman bu yanıtı da modası geçmiş hale getirecek. Modası geçmiş modüllere bağlı oldukları için günümüz sistemlerinde çalışamayan PYK ve RIP gibi birkaç öneriyi kontrol ettim, bu yüzden ...
theta

3
Uzun zamandır aradıklarımı bana sağlayan vim addon riv.vim'e link ekledim. github.com/Rykka/riv.vim
Jan Vlcinsky
Sitemizi kullandığınızda şunları okuyup anladığınızı kabul etmiş olursunuz: Çerez Politikası ve Gizlilik Politikası.
Licensed under cc by-sa 3.0 with attribution required.