TypeFriendly
TypeFriendly jest generatorem opracowań i podręczników w formacie HTML. Napisany jest w PHP5 i umożliwia pisanie dokumentów w prostej i czytelnej składni Markdown.
TypeFriendly to projekt generatora podręczników HTML-owych napisany w PHP5, którego głównym założeniem jest prostota użytkowania. W porównaniu z innymi zaawansowanymi systemami takimi, jak DocBook, nie musisz samodzielnie opracowywać całego zestawu narzędziowego do zapewnienia odpowiedniej funkcjonalności. Z TypeFriendly dostajesz gotowe do użycia wszystko, co potrzeba i możesz zacząć pisanie swojego podręcznika w przeciągu paru minut.
Cechy TypeFriendly:
- Dokumentacja generowana z plików tekstowych tworzonych w przejrzystym i łatwym do nauczenia się formacie Markdown, opatrzonych dodatkowymi tagami.
- Automatyczne łączenie plików w rozdziały i sekcje na podstawie ich nazw.
- Intuicyjne zarządzanie kolejnością rozdziałów.
- Automatyczne tworzenie nawigacji.
- Wsparcie dla kolorowania składni wielu różnych języków.
- Dodatkowe narzędzia do opisu API obiektowego.
- Wsparcie dla wielojęzycznych dokumentacji, w tym narzędzie do kontroli aktualności wybranej wersji językowej.
- Kilka dostępnych systemów wyjścia.
- Elegancka oprawa graficzna generowanych dokumentacji.
TypeFriendly może być wykorzystany do różnych celów:
- Tworzenie podręcznika użytkownika dla Twojego projektu.
- Publikowanie książki lub zbioru artykułów w formacie HTML.
- Dokumentowanie Twojego projektu.
- Przygotowywanie wewnętrznych opracowań łatwo dostępnych w sieci.
Obecnie TypeFriendly jest podstawowym narzędziem dokumentacyjnym w Invenzzii i nie zamierzamy zamykać się wyłącznie w świecie HTML-a. Celem jest stworzenie systemu publikowania książek oraz opracowań w najpopularniejszych dostępnych formatach z bardzo czytelnej, tekstowej formy źródłowej. Aktualna wersja, 0.1.1 jest do pobrania w dziale Download.