teedoc

Teedoc

中文 | Englisch

Offizielle Website: teedoc.neucrack.com oder teedoc.github.io

MEHR Demo: Hier oder hier siehe

Dokumentation generieren Tool von Markdown und Jupyter Notebook zu HTML

teedoc kann in den folgenden Szenarien verwendet werden:

• Erstellen Sie eine Dokumentwebsite und unterstützen Sie am besten mehrere Dokumente und benutzerdefinierte Seiten
• Die Dokumente von Organisationen oder Unternehmensdokumenten verbreiten sich in verschiedenen Bereichen und möchten sie an einer Website (Domain) kombinieren.
• Erstellen Sie eine WiKi -Website
• Bauen Sie eine persönliche oder korporative Wissensbasis auf
• Bauen Sie eine persönliche oder Unternehmenswebsite auf

Merkmale

• Einfach zu bedienend, überqueren Plattform, nur Python3 benötigen
• Einfach zu bereitgestellt, kopieren Sie nur generierte StAITC -HTML -Dateien auf Ihren Server oder einen anderen Host
• Einfach zu schreiben, Markdown -Unterstützung
• Jupyter Notebook Support
• Mehrfachunterhaltsunterstützung
• Plugin -Unterstützung
• Mehrfachthemaunterstützung (Support nach Plugin)
• Steuern Sie den auf der Seite genauen Stil über CSS (implementiert durch Anpassen der ID und Klasse jeder Seite).
• Multi-Level-Verzeichnisunterstützung
• Multisprachiger Unterstützung (manuelle Übersetzung) (Internationalisierung/i18n)
• Mehrsprachiger Unterstützung (Übersetzungs -Plugin)
• Support für mehrere Versionen
• Unterstützung durchsuchen
• SEO -freundlich
• Änderungen der Echtzeit-Vorschauerdatei
• Parallele Build, schnellere Build -Geschwindigkeit
• Blog -Unterstützung
• Jinja2 HTML -Layout -Vorlageunterstützung

Fangen an

Besuchen Sie die offizielle Website: teedoc.github.io oder teedoc.neucrack.com

Erstellen Sie Ihre Website auf GitHub -Seiten in Minuten

Siehe Vorlage Repo

Quik Start

• Installieren Sie Python3

Laden Sie unter Windows oder macOS von python.org herunter

Unter Linux , Ubuntu zum Beispiel:

 sudo apt install python3 python3-pip

• TEEDOC einbauen

Dieser Befehl installiert das TEDOC -Programm

 pip3 install -U teedoc

• Dokument initialisieren

 mkdir my_site
cd my_site
teedoc init

oder

 teedoc -d my_site init

Wählen Sie minimale Vorlage im Promot

• Plugins installieren

In diesem Befehl werden Plugins installiert, die von DOC verwendet werden (festgelegt in site_config.json )

 cd my_site
teedoc install

• bauen oder dienen

 teedoc serve

Dann besuchen Sie http://127.0.0.1:2333 im Browser

Wenn Sie nur HTMLs generieren möchten:

 teedoc build