Jekyll mais simples
Um site mínimo baseado em Jekyll em páginas GH, reduzido a uma página de conteúdo com um tema
Visualização
Sobre
Este é um modelo de demonstração de modelo e ao vivo. Ele mostra o quão pouco você precisa configurar para obter um site Jekyll nas páginas GH.
- Index.md
- Para a página inicial - a única página neste caso.
- Se você deixar de fora esta página,
README.md será usado como sua página inicial.
- _config.yml
- Defina o tema - que lida com o layout e o estilo.
- Ativar plug -in Jekyll Sitemap - ativá -lo no GemFile não é suficiente. Observe que outros plugins serão ativados para você, como o FrontMatter opcional.
- Outros valores padrão, como
baseurl , title e description foram deixados de fora da configuração. Ao construir em páginas de GH, elas serão inferidas para você pelas páginas GH Gem.
- GemFile
- Na verdade, isso não é usado pelas páginas GH, mas permite que você instale o tema Jekyll localmente usando o Bundler.
- Use uma única geme
github-pages se você deseja corresponder a todas as gemas nas páginas GH (que podem ser pesadas para instalar). - Exclua este arquivo se não precisar executar seu site localmente.
Se você deseja um exemplo mais completo de um site de várias páginas com postagens, gemas, layouts, etc., verifique meu repo Jekyll-blog-Demo. Isso também pode ser usado como um modelo e um site de demonstração.
Como usar este projeto
Configurar
- Clique em usar este modelo para criar um novo repositório em sua própria conta. Você pode deixar o nome como
simplest-jekyll . - Ative as páginas do Github nas configurações do seu repo. Opte por servir no
master Branch e na opção / caminho. - Verifique a guia Environment do seu repositório para ver quando a implantação é concluída.
- Clique em Exibir a implantação para ver o site ao vivo. Por exemplo, https://michaelcurrin.github.io/simplest-jekyll/
Observe que /simplest-jekyll/index.html está disponível imediatamente, mas leva alguns minutos até que as páginas do github façam /simplest-jekyll/ disponíveis.
Personalizar
- Atualize o
README.md com seus próprios detalhes. Na verdade, isso não é usado no site implantado, mas é visível localmente e no GitHub. - Temas
- Edite o tema em _config.yml se você quiser outro tema.
- Você também pode usar a seção Páginas do Github das configurações de repo para visualizar visualmente.
- NOTA Somente os temas suportados pelas páginas do GitHub são cobertos (cerca de 10), mas se você usar o campo REMOTE_THEME em sua configuração, poderá fazer referência a mais temas.
- Para instalar e funcionar localmente, você precisará garantir que o seu GemFile cubra o tema usado na configuração.
- Como na maioria dos sites Jekyll, o index.md é usado como página inicial.
- Possui matéria frontal na parte superior para que qualquer líquido seja aplicado.
- Edite seu arquivo
index.md com seu próprio conteúdo como HTML ou Markdown. - Você pode renomeá -lo para
index.html se você deseja apenas html simples. - Você pode remover o assunto frontal na parte superior para remover a formatação líquida e qualquer tema.
- Se desejar, adicione mais páginas na raiz e quebre qualquer html comum, como cabeçalho ou cabeça ou barra de marinho na pasta
_includes ou pasta _layouts (nenhum deles está coberto no escopo deste projeto, mas é comum para projetos Jekyll). - Consulte os documentos e tutoriais no site Jekyll para obter mais informações.
- Opcionalmente, execute Jekyll localmente:
- Instale o rubi e o grupo.
- Instale o Project Gems - Jekyll e The Theme Gem.
- Execute o servidor Jekyll Dev.
- Para instruções mais completas, consulte a demonstração do blog Docs of Jekyll. Você também precisará adicionar um
Makefile para corresponder a esses comandos.
Projetos relacionados
- - Blog padrão gerado com Jekyll CLI. Usando um tema, conteúdo, estilo configurado, gemas e um makefile.
- - Usando Jekyll 4, um tema, ações do GitHub e páginas do Github.
- - Site Jekyll mínimo com um tema, mas sem gemfile.
Licença
Lançado no MIT por @michaelcurrin.
