Markowik on Python-sovellus, joka muuntaa Markdown muotoiltua tekstiä Google Code Wiki.
Markowik pystyy muuntamaan eniten Wikitekstin konstruktioita sen Google Code Wiki (GCW) vastineet. Sen sijaan, että luetellaan kaikki tuetut muunnokset, ota vilkaista Markowik testi sviitti ja sen vitriini.
Asennus
Run:
Pip asentaa markowik
tai:
easy_install markowik
Voit myös käyttää Markowik ilman asennusta, kuten kohdassa Avusta.
Command Line Käyttö
Ohje-lähtö:
Käyttö: markowik [-h] [--mx [MX [MX ...]]] [--image-baseurl URL]
& Nbsp; [- html-kuvia] [--encoding ENKOODAUSVÄLINEET] [--quiet]
& Nbsp; INFILE [OUTFILE]
Muunna Markdown Google Code Wiki.
asentohuimaus perustelut:
& Nbsp; INFILE markdown tiedosto
& Nbsp; OUTFILE wiki tiedosto (oletus: stdout)
valinnaiset argumentit:
& Nbsp; -h, --help näytä tämä ohje ja poistu
& Nbsp; - mx [MX [MX ...]] markdown laajennuksia aktivoida
& Nbsp; - kuva-baseurl URL base URL prepend suhteellista kuva paikkoihin
& Nbsp; - html-kuvia aina käyttää HTML kuville
& Nbsp; - koodaus ENKOODAUSVÄLINEET koodaus tulon ja lähdön (oletus: UTF8)
& Nbsp; - hiljainen poista tiedotteita
Markdown laajennukset voidaan antaa samalla siitä Python Markdown (PyMD) komentorivi työkalu, sillä poikkeuksella, että yksittäiset laajennukset on erotettava toisistaan välilyönnillä:
markowik INPUT --mx pöydät def_list
Tällä hetkellä tukea (eli testattu) laajennukset ovat abbr, pöydät, ja def_list. Muut laajennuksia yleensä pitäisi toimia myös, mutta voi tuottaa odottamattomia tuloksia muunnettu wiki tekstiä.
Mitä vaihtoehto --html-kuvia, katso selitykset alla osoitteessa Rajoitukset.
Ohjelmalliset Käyttö
Markowik toteutetaan Python. Markowik moduuli tarjoaa funktio nimeltä käännynnäinen. Semanttisesti se on samanlainen komentoriviltä (avainsana argumentit vastaavat komentorivin). Tässä lyhyt käyttö esimerkki:
>>> Tuonti markowik
>>> Markowik.convert ("Jotkut * markdown * tekstiä ...", mx = ['taulukot'])
u'Some _markdown_ tekstiä ... "
Sivu Pragmat
GCW sivu Pragmat voidaan asettaa Markdown lähdetiedostoihin metatietona muodossa määritelty PyMD meta laajennus:
>>> Src = "" "Yhteenveto: sivun yhteenveto
... Labels: jotkut, tarrat
...
... Täällä alkaa * sivu * ..
... "" "
>>> Print markowik.convert (src, mx = ['meta'])
#summary sivun yhteenveto
#labels jotkut, tarrat
Täällä alkaa _page_ ..
Huomaa, että meta laajennus on käytössä nimenomaan, eli oletuksena Markowik ei tunnista sivun Pragmat.
Mitä uutta tässä julkaisussa:
< ul>
Mitä uutta versiossa 0.1.1:
- Parempi dokumentointi.
- pienempiä korjauksia.
Vaatimukset :
- Python
Rajoitukset :
- GCW voi ilmaista kaikkia markup mahdollista Markdown. Tämä tarkoittaa Markdown lähdetiedostoihin tulee kirjoittaa seuraavat rajoitukset mielessä.
- URL Linkit ja kuvat:
- URL-linkeissä käytettävät tai kuvan lähteitä on oltava ehdoton, ja on oltava erityisen pöytäkirjan saada tunnustettu GCW. Erityisesti kaikki URL tulee alkaa http: //, https: // tai ftp: //. Markowik keskeyttää muuntaminen, jos se havaitsee URL-ei vastaa näitä vaatimuksia.
- Typefacing Link nimet:
- GCW ei tue typefacing linkin nimiä. Esimerkiksi GCW tekee linkin nimi [http://foo.com _Foo_] kirjaimellisesti, eli kuten _Foo_. Kuitenkin GCW tunnustaa typefacing HTML linkkejä, eli & lt; href = & quot; http: //foo.com" & Gt; _Foo_ & lt; / & Gt; korostuu asianmukaisesti. Tästä syystä Markdown yhteyksiä sisäkkäisiä typefacing kuten [* Foo *] (http://foo.com) muunnetaan HTML linkkejä. Tämän seurauksena linkki tarrat tiettyjä erikoismerkkejä, jotka on pakeni GCW käyttäen backtick (`) merkkiaineet johtaa myös HTML-linkkejä.
- sisäkkäisiä Edellä:
- GCW ei todellakaan tue useita sisäkkäisiä kohdat (esim luetteloita tai blockquotes). Markowik simuloi useita sisäkkäisiä kohdat erottamalla ne & lt; br / & gt; (Joka visuaalisesti jäljittelee kohdassa mutta ei riko pesiviä ympäristö).
- Kuvat:
- Markdown avulla ilmaista vaihtoehtoisia ja otsikkotekstit kuville. GCW imagoa syntaksin ei tue tätä. Ainoa tapa säilyttää nämä tekstit on käyttää HTML & lt; img & gt; tunnisteet. Vaihtoehto --html-kuvia mahdollistaa tätä ratkaisua.
- Toinen asia on, että GCW odottaa kuvan URL-päättyä kuvan tiedostotyyppi laajennus. Markowik lisää keinotekoinen kuva laajennukset tarvittaessa esimerkiksi http://foo.bar/image vaihdetaan http://foo.bar/image?x=x.png.
- Lyhenteet:
- GCW ei lisähinta lyhenteitä eikä se tue HTML tag & lt; abbr & gt ;. Markowik muuntaa lyhenteitä & lt; span & gt; -elementin, millaisia jäljittelee lyhenteet (vuonna rajoitetusti tietenkin).
- HTML:
- Jokainen HTML esiintyvät Markdown lähde päätyy kirjaimellisesti GCW (lukuun ottamatta sisältöä span tason tunnisteet). Tämä tarkoittaa Markdown lähde pitäisi sisältää ainoastaan HTML tukee GCW. Toinen seuraus on, että URL-osoitteet käytetään HTML koodit eivät ole tarkistettu GCW yhteensopivuuden. Toisin sanoen: kun käytetään raaka HTML olet oman!
Kommentteja ei löytynyt