h-cli
v0.1.2
Published
Criar simples galeria de imagens.
Downloads
10
Readme
h
Criar simples galeria de imagens.
Instale-o com npm install --global h-cli
.
Uso
$ h
Uso: h [comando] <...>
Comando: Descrição:
novo <dirname> Criar um novo site.
construir <dirname> Construir arquivos do site.
Para criar um site novo, use o comando h novo <dirname>
. Onde <dirname>
é o nome do diretório em que ele será gerado. Em seguida, algumas informações para as configurações dele será pedido e então os arquivos serão gerados.
Use h construir
para construir os arquivos do site. Onde isto só funcionará se você estiver no diretório do site, caso contrário você poderá informar o diretório no próximo argumento, por exemplo, h construir foo
.
Para construir os arquivo do site você deverá ter um tema para ele, onde os temas deverão estar no diretório tema
que por padrão é vazio, portanto você deverá criar ou baixar um tema. Encontre temas, pesquisando no GitHub, tente usar o tópico h-tema: topic:h-tema
.
As imagens a serem exibidas no site deverão estar no diretório imagens
.
Criando um Tema
Os arquivos deverão estar no diretório tema
. Os únicos arquivos necessários são index.html
e postagens.html
. Onde:
index.html
― Arquivo principal (e único).postagens.html
― Arquivo somente com as postagens.
Para entender melhor veja um tema em: <https://github.com/theuves/h-mini-tema>.
Esses arquivos recebem alguns dados que devem ser representados dentro de chaves {{
e }}
.
O arquivo index.html
receberá:
{{titulo}}
― Título do site (que foi informado noconfig.json
).{{descricao}}
― Descrição do site (que foi informado noconfig.json
).{{autor}}
― Nome do autor do site (que foi informado noconfig.json
).{{postagens}}
― Todo o conteúdo depostagens.html
.{{versao}}
― Versão atual desta ferramenta.
Todo o conteúdo de postagens.html
será repetido conforme a quantia de imagens que estiver no diretório imagens
. Este arquivo receberá os seguintes dados:
{{imagem}}
― O URL de onde a imagem está (emimagens/*
).{{descricao}}
― Este dado não é a descrição do site e sim a descrição da imagem que deve ser informada com o ajuda da ferramenta atras. (vejaatras
ouatras-gui
).{{autor}}
― Nome do autor do site (que foi informado noconfig.json
).{{versao}}
― Versão atual desta ferramenta.
Licença
MIT © Matheus Alves