teedoc

teedoc

中文 | Inglês

Site oficial: teedoc.neucrack.com ou teedoc.github.io

Mais demo: veja aqui ou aqui

Documentação Gere ferramenta do Markdown e Jupyter Notebook para HTML

teedoc pode ser usado nos seguintes cenários:

• Crie um site de documentos e é melhor suportar vários documentos e páginas personalizadas
• Os documentos de organizações ou empresas espalhados em diferentes domínios, desejam combiná -los em um site (domínio)
• Construa um site WiKi
• Construir base de conhecimento pessoal ou corporativo
• Construir site pessoal ou corporativo

Características

• Fácil de usar, Cross Platform, precisa apenas Python3
• Fácil de implantar, apenas cópia gerou arquivos HTML para seu servidor ou outro host
• Fácil de escrever, suporte de remarca
• Suporte de notebook Jupyter
• Múltiplos documentos de suporte
• Suporte ao plug -in
• Suporte de temas múltiplos (suporte por plug -in)
• Controle o estilo preciso para a página através do CSS (implementado pela personalização do ID e da classe de cada página)
• Suporte de diretório de vários níveis
• Suporte multi-linguagem (tradução manual) (Internacionalização/I18N)
• Suporte multilíngue (plugin de tradução)
• Suporte múltiplo de versão
• Suporte de pesquisa
• SEO amigável
• Mudanças de arquivo de visualização em tempo real
• Construção paralela, velocidade de construção mais rápida
• Suporte ao blog
• Jinja2 HTML Layout Modelo Suporte

Comece

Visite o site oficial: teedoc.github.io ou teedoc.neucrack.com

Crie seu site nas páginas do Github em minutos

Veja o repo de modelo

Quik Start

• Instale o Python3

No Windows ou macOS , faça o download de python.org

No Linux , Ubuntu por exemplo:

 sudo apt install python3 python3-pip

• Instale o teedoc

Este comando instalará o programa teedoc

 pip3 install -U teedoc

• Inicialize o documento

 mkdir my_site
cd my_site
teedoc init

ou

 teedoc -d my_site init

Selecione o modelo mínimo em promoção

• Instale os plugins

Este comando instalará os plugins usados ​​pelo doc (definido em site_config.json )

 cd my_site
teedoc install

• construir ou servir

 teedoc serve

Em seguida, visite http://127.0.0.1:2333 no navegador

Se você deseja gerar apenas htmls:

 teedoc build