Markowik

Markowik er en Python app, der konverterer Markdown formateret tekst til Google Code Wiki.
Markowik kan konvertere de fleste Markdown konstruktioner til sine Google Code Wiki (GCW) ækvivalenter. I stedet for en liste over alle understøttede konverteringer, skal du have et kig på Markowik test suite og dens show sag.
Installation
Kør:
pip installere markowik
eller:
easy_install markowik
Du kan også bruge Markowik uden installation, som beskrevet under Contribute.
Command Line Anvendelse
Fra den hjælp output:
forbrug: markowik [-h] [--mx [MX [MX ...]]] [--image-BaseURL URL]
& Nbsp; [- html-billeder] [--encoding KODNING] [--quiet]
& Nbsp; INFILE [OUTFILE]
Konverter Markdown til Google Code Wiki.
positionelle argumenter:
& Nbsp; INFILE markdown fil
& Nbsp; OUTFILE wiki-fil (default: stdout)
valgfri argumenter:
& Nbsp; -h, --help vise denne hjælpetekst og afslut
& Nbsp; - mx [MX [MX ...]] Markdown udvidelser for at aktivere
& Nbsp; - billede-BaseURL URL grund URL til tilføjes i begyndelsen til relative billede placeringer
& Nbsp; - html-billeder altid bruge HTML til billeder
& Nbsp; - kodning ENCODING kodning af input og output (default: UTF8)
& Nbsp; - stille deaktivere infobeskeder
Markdown extensions kan gives på samme måde som til Python Markdown (PyMD) kommandolinje værktøj, med den undtagelse, at de enkelte udvidelser skal være adskilt af et mellemrum:
markowik INPUT --mx tabeller def_list
De aktuelt understøttede (dvs. testet) udvidelser er forkortet, borde, og def_list. Andre udvidelser generelt bør arbejde også, men kunne give uventede resultater i den konverterede wiki tekst.
Hvad angår muligheden for --html-billeder, se forklaringerne nedenfor på Begrænsninger.
Programmatic Anvendelse
Markowik er implementeret i Python. Den markowik modul giver en funktion med navnet konvertit. Semantisk det svarer til kommandolinjen (søgeord argumenter svarer til kommandolinjetilvalg). Her er en kort forbrug eksempel:
>>> Import markowik
>>> markowik.convert ("Nogle * markdown * tekst ...", MX = ['tabeller'])
u'Some _markdown_ tekst ... «
Side Pragmas
GCW side pragmas kan indstilles i Markdown kildefiler som metadata i det format defineret af PyMD meta udvidelse:
>>> Src = "" "Resumé: side resumé
... Etiketter: nogle, etiketter
...
... Her starter * siden * ..
... "" "
>>> Print markowik.convert (src, mx = ['meta'])
#summary side resumé
#labels nogle, etiketter

Her starter _page_ ..
Bemærk, at meta lokalnummer være aktiveret eksplicit, dvs. som standard Markowik genkender ikke side pragmas

Hvad er nyt i denne udgivelse:.

< ul>

Hvad er nyt i version 0.1.1:.

• Forbedret dokumentation
• mindre rettelser.

Krav :

• Python

Begrænsninger :

• GCW kan ikke udtrykke alle mulige markup i Markdown. Det betyder Markdown kildefiler skal skrives med følgende begrænsninger i tankerne.


• URL'er i links og billeder:
• webadresser anvendes til links eller billedkilder skal være absolut og skal have en særlig protokol til at få anerkendt af GCW. Navnlig skal enhver URL starte med http: //, https: // eller ftp: //. Markowik afbryder konverteringen, hvis den finder webadresser ikke opfylder disse krav.


• Typefacing i Link Navne:
• GCW understøtter ikke typefacing i link navne. Eksempelvis GCW gør linknavnet i [http://foo.com _Foo_] bogstaveligt, dvs. som _Foo_. Men GCW genkender typefacing i HTML-links, dvs. & lt; a href = & quot; http: //foo.com" & Gt; _Foo_ & lt; / A & gt; understreges korrekt. Derfor Markdown forbindelser med indlejret typefacing ligesom [* Foo *] (http://foo.com) vil blive konverteret til HTML links. Som et resultat, link etiketter med visse specialtegn som skal undsluppet i GCW hjælp accent grave (`) markører vil også resultere i HTML-links.


• indrykket afsnit:
• GCW ikke rigtig understøtter flere indrykkede afsnit (f.eks lister eller blockquotes). Markowik simulerer flere indrykkede afsnit ved at adskille dem med et & lt; br / & gt; (Som visuelt efterligner stykker, men bryder ikke nesting miljø).


• Billeder:
• Markdown gør det muligt at udtrykke alternative og titel tekster til billeder. GCW image syntaks understøtter ikke dette. Den eneste måde at bevare disse tekster er at bruge almindelig HTML & lt; img & gt; tags. Muligheden --html-billeder giver denne løsning.
• Et andet problem er, at GCW forventer billede webadresser til at ende med et billede filtype forlængelse. Markowik tilføjer kunstige billede extensions, hvis nødvendigt, f.eks http://foo.bar/image ændres til http://foo.bar/image?x=x.png.


• Forkortelser:
• GCW har ingen markup for forkortelser heller ikke understøtter HTML-tag & lt; forkortet & gt ;. Markowik konverterer forkortelser til & lt; span & gt; -elementer hvilken slags efterligner forkortelser (i et begrænset omfang naturligvis)
.

• HTML:
• Enhver almindelig HTML forekommer i en Markdown kilde ender bogstaveligt i GCW (med undtagelse af indholdet af span niveau tags). Det betyder, at Markdown kilden bør kun indeholde HTML understøttes af GCW. En anden implikation er, at webadresser, der anvendes i almindelig HTML-tags er ikke kontrolleret for GCW kompatibilitet. Med andre ord: når du bruger rå HTML, du er på din egen
!