Markowik

Markowik to aplikacja Pythona, który przekształca Markdown sformatowany tekst do Google Code Wiki.
Markowik jest w stanie przekształcić większość konstrukcji Markdown swoim Google Code Wiki (GCW) ekwiwalentów. Zamiast wymieniając wszystkie obsługiwane konwersje, proszę spojrzeć na zestaw testów Markowik i jego pokaz przypadku.
instalacji
Uruchom:
pip install markowik
lub:
easy_install markowik
Możesz także użyć Markowik bez instalacji, jak opisano w Contribute.
Command Line Zastosowanie
Z wyjścia pomocy:
Wykorzystanie: markowik [-h] [--mx [MX [MX ...]]] [--image-baseurl URL]
& Nbsp; [- html zdjęcia] [--encoding KODOWANIE] [--quiet]
& Nbsp; INFILE [OUTFILE]
Konwersja Markdown do Google Code Wiki.
pozycyjne argumenty:
& Nbsp; INFILE plików Przecena
& Nbsp; OUTFILE plików wiki (domyślnie: stdout)
Opcjonalne argumenty:
& Nbsp; -h, --help pokazuj tego komunikatu pomocy i kończy
& Nbsp; - mx [MX [MX ...]], aby uaktywnić rozszerzenia Przecena
& Nbsp; - obraz-baseurl baza URL URL dokleja się do względnych miejscach obrazu
& Nbsp; - html zdjęcia zawsze używać HTML obrazów
& Nbsp; - kodowanie kodowanie kodowanie wejścia i wyjścia (domyślnie: UTF-8)
& Nbsp; - ciche wyłączanie wiadomości informacji
Rozszerzenia Przecena może mieć podobnie jak do narzędzia wiersza poleceń Python Markdown (PyMD), z zastrzeżeniem, że poszczególne rozszerzenia muszą być oddzielone spacją:
markowik tabel wejściowych --mx def_list
Obecnie obsługiwane (tj testowane) rozszerzenia są w skrócie, tabele i def_list. Inne rozszerzenia na ogół powinno działać też, ale może doprowadzić do niespodziewanych wyników w przebudowanej tekstu wiki.
Co do opcji --html-images, patrz wyjaśnienia poniżej w ograniczeniach.
Programowa Zastosowanie
Markowik realizowany jest w Pythonie. Moduł markowik zapewnia funkcję o nazwie nawrócił. Semantycznie jest podobny do interfejsu wiersza poleceń (argumenty słów kluczowych odpowiadają Opcje wiersza poleceń). Oto krótki przykład użycia:
>>> Import markowik
>>> markowik.convert ("Niektóre * Przecena * tekst ...", mx = ['']) tabele
Tekst u'Some _markdown_ ... "
Strona pragmy
GCW strona pragmy można ustawić w plikach źródłowych Markdown jak meta danych w formacie określonym przez meta rozszerzenia PyMD:
>>> Src = "" "Podsumowanie: Podsumowanie strona
... Etykiety: niektóre, etykiety
...
... Tutaj zaczyna stronę * * ..
... "" "
>>> Print markowik.convert (src, mx = ['meta'])
#summary podsumowanie strona
#labels pewne, etykiety

Tutaj rozpoczyna _page_ ..
Należy zauważyć, że rozszerzenie meta musi być włączony wyraźnie, tj domyślnie Markowik nie rozpoznaje stron pragmy

Co nowego w tym wydaniu:.

< ul>

Co nowego w wersji 0.1.1:.

• Dokumentacja Lepsza
• Drobne poprawki.

Wymagania :

• Python

Ograniczenia :

• GCW może nie wyrazić wszystkie znaczników możliwe w promocji cenowych. Oznacza to pliki źródłowe Przecena powinien być napisany z następującymi ograniczeniami w umyśle.


• URL bbli w linki i obrazki:
• adresy wykorzystywane do linków lub źródeł obrazu musi być bezwzględna i musi mieć konkretny protokół, aby uznane przez GCW. W szczególności, każdy adres URL musi zaczynać się od http: //, https: // lub ftp: //. Markowik przerywa konwersji, jeżeli stwierdzi, adresy URL, nie pasujące do tych wymagań.


• Typefacing w Link, nazwy:
• GCW nie obsługuje typefacing w linkach. Na przykład GCW świadczy nazwę linku w [http://foo.com _Foo_] dosłownie, czyli jako _Foo_. Jednak GCW rozpoznaje typefacing w linki HTML, czyli & lt; a href = & quot; http: //foo.com" & Gt; _Foo_ & lt; / & Gt; podkreśla się prawidłowo. Z tego powodu linków Markdown z zagnieżdżonego typefacing jak [* Foo *] (http://foo.com) zostaną zamienione na linki HTML. W rezultacie, etykiety związek z niektórymi znakami specjalnymi, które mają być chronione za pomocą znaku odwróconego apostrofu w GCW (`) markery spowoduje również linki HTML.


• Zagnieżdżony Punkty:
• GCW naprawdę nie obsługuje wielu zagnieżdżonych akapitów (np na listach lub w cytowaniach). Markowik symuluje wiele zagnieżdżonych pkt oddzielając je & lt; br / & gt; (Które wizualnie naśladuje ust, ale nie złamać zagnieżdżenia środowiska).


• Obrazy bbli:
• Markdown pozwala wyrazić alternatywnych i tytuł tekstów do zdjęć. Składnia obrazu GCW za nie obsługuje tej funkcji. Jedynym sposobem, aby zachować te teksty jest używać zwykłego HTML & lt; img & gt; tagi. Opcja --html-images umożliwia to obejście.
• Inną kwestią jest to, że adresy URL obrazu oczekuje GCW kończyć się rozszerzeniem obrazu typu plików. Markowik dodaje sztucznych rozszerzenia obrazu w razie potrzeby, na przykład http://foo.bar/image zmienia się na http://foo.bar/image?x=x.png.


• Skróty:
• GCW ma znaczników dla skrótów ani nie obsługuje znacznika HTML & lt; skr & gt ;. Markowik konwertuje skróty do & lt; Rozpiętość & gt; -elements jaki rodzaj naśladuje skrótów (w ograniczonym oczywiście)
.

• HTML:
• zwykły HTML występujących w źródle Markdown kończy się dosłownie GCW (z wyjątkiem zawartości znaczników okres podstawowy). Oznacza to źródło promocji cenowych powinna zawierać tylko HTML obsługiwana przez GCW. Inną konsekwencją jest to, że adresy URL stosowane w prostych znaczników HTML nie są sprawdzane pod kątem zgodności GCW. Innymi słowy: przy użyciu znaczników HTML jesteś na własną rękę,
!