shokunin

Gerador de site estático Shokunin (SSG)

Um gerador de sites estáticos com foco no conteúdo criado em Rust, otimizado para desempenho, acessibilidade e visibilidade do mecanismo de pesquisa.

• Site • Documentação • Relatar bug • Recurso de solicitação • Diretrizes de contribuição

Visão geral

Shokunin é um gerador de site estático (SSG) de alto desempenho projetado em Rust que prioriza:

• Abordagem de desenvolvimento que prioriza o conteúdo
• Geração de sites extremamente rápida
• Conformidade de acessibilidade WCAG 2.1 Nível AA
• Otimização SEO avançada
• Operações de tipo seguro com tratamento de erros abrangente

Principais recursos

Capacidades principais

• ⚡ Desempenho excepcional : abstrações de custo zero por meio do Rust
• Otimização de SEO : melhorias integradas para visibilidade de pesquisa
• ♿ Acessibilidade : Conformidade automática com WCAG 2.1 Nível AA
• Suporte multiformato : lida com Markdown, YAML, JSON e TOML
• Geração de feed : criação automática de feed Atom e RSS
• Analytics : integração nativa do Google e Bing Analytics
• ? Temas : temas HTML personalizados e suporte a modelos

Recursos de desenvolvimento

• ? Ferramentas CLI : interface de linha de comando abrangente
• Dev Server : servidor Rust integrado para desenvolvimento local
• ? Hot Reload : atualizações automáticas de conteúdo durante o desenvolvimento
• Segurança de tipo : memória garantida e segurança de thread
• ⚡ Suporte assíncrono : recursos completos de operação assíncrona

Começando ?

Instalação

Adicione ao seu Cargo.toml :

[ dependencies ]
ssg = " 0.0.32 "

Ou instale via Cargo:

cargo install ssg

Uso Básico

 use staticdatagen :: compiler :: service :: compile ;
use std :: { path :: Path , error :: Error } ;

fn main ( ) -> Result < ( ) , Box < dyn Error > > {
    // Define directory paths
    let build_dir = Path :: new ( "./examples/build" ) ;          // Build directory
    let content_dir = Path :: new ( "./examples/content" ) ;      // Content directory
    let public_dir = Path :: new ( "./examples/public" ) ;        // Public directory
    let template_dir = Path :: new ( "./examples/templates" ) ;   // Templates

    // Generate site
    compile ( build_dir , content_dir , public_dir , template_dir ) ? ;
    println ! ( " Site generated successfully!" ) ;
    Ok ( ( ) )
}

Uso CLI

Crie um novo site:

 # Full command syntax
ssg --content=content --template=templates --serve=public

# Short form
ssg -c=content -t=templates -o=output -s=public

# Using cargo run
cargo run --bin ssg -- -c= " ./examples/content " -t= " ./examples/templates " -s= " ./examples/public "

Opções CLI

Opção	Curto	Descrição	Obrigatório
--content	-c	Caminho do conteúdo	Sim
--template	-t	Caminho do modelo	Sim
--serve	-s	Caminho público do servidor	Sim

Exemplos

Experimente nossos exemplos de implementações:

 # Basic example
# # Convert Markdown to static sites effortlessly, with templates, organized builds, and instant local hosting.
git clone https://github.com/sebastienrousseau/shokunin.git
cd shokunin
cargo run --example basic

# Quick start example
# # Create, compile, and host a static site effortlessly with Shokunin: simple setup, error handling, and instant local server for previews.
cargo run --example quickstart

# Multilingual example
# # Build multilingual static sites effortlessly: generate language-specific sites, create a language selector, and serve all from a single directory.
cargo run --example multilingual

Documentação

• Documentação da API
• Guia do usuário
• Diretrizes de contribuição

Contribuindo?

Aceitamos contribuições! Consulte nossas Diretrizes de Contribuição para obter detalhes sobre:

• Código de Conduta
• Processo de Desenvolvimento
• Diretrizes de solicitação pull
• Relatório de problemas

Licença?

Este projeto tem licença dupla sob:

• Licença Apache, Versão 2.0
• Licença MIT

a sua opção.

Agradecimentos

Agradecimentos especiais a todos os contribuidores que ajudaram a construir o Shokunin.