Markdoc jest doskonała do dokumentacji technicznej, podręczników, wewnętrznej wiki projektu lub statycznych pokoleń miejscu.
Do dokumentacji technicznej / Podręczniki, Markdoc może być używany do pisania i uczynić odręczne przewodniki i instrukcje dla oprogramowania. Taka dokumentacja jest zazwyczaj oddzielona od generowanego automatycznie dokumentacji API, a może dać pogląd na wyższym poziomie niż sam docs API. Może być stosowany do dokumentacji klienta dla aplikacji internetowych / stacjonarnych, a nawet dokumentację dla deweloperów z ram.
Dla Wewnętrznego projektu wiki, wiki Markdoc składać się z jednego pliku tekstowym na stronie. Łącząc wiki z DVCS (takich jak Mercurial lub Git), może współpracować z kilkoma innymi osobami. Użyj dvcs śledzić, akcji i scalić zmiany z siebie i zobaczyć wiki & rsquo; s historii.
Dla Static generacji strony, Markdoc konwertuje wiki w surowe plików HTML i mediów. To pozwala na zarządzanie, osobisty blog, stronę internetową lub zbiór stron wiki Markdoc, być może z niestandardowych stylów CSS, i publikuje renderowany HTML do strony internetowej. Markdoc nie musi być zainstalowany na stronie hostingu, ponieważ wynikowy HTML jest całkowicie niezależny
Cechy .
- Ustaw Google śledzenie w jednej linii konfiguracji Analytics.
- wiki Barebones, że po prostu wyglądają jak katalogów z promocji cenowych sformatowanych plików tekstowych w nich.
- Wbudowany serwer HTTP i stosowaniu się służyć WSGI skompilowany wiki z jednego polecenia.
- Ciągłe buduje (przez rsync) oznacza, że serwer może biec jednocześnie Markdoc ponownie kompiluje wiki. Wystarczy odświeżyć przeglądarkę, aby zobaczyć zmiany.
- Dodaj Pygments-powered podświetlanie składni do wiki Markdoc z jednego parametru konfiguracyjnego.
- Markdoc to oprogramowanie do domeny publicznej. To zawsze będzie całkowicie bezpłatne i można je rozpowszechniać (w całości lub w części) w żadnym wypadku (open-source, zastrzeżone lub w inny sposób) bez atrybucji lub encumberances.
Wymagania :
- argparse
- CherryPy
- Jinja2
- Markdown
- Pygments
- PyYAML
- webob
- Python 2.4 lub nowszy,
- rsync
Komentarze nie znaleziono