jake

Jake é uma ferramenta que permite criar sem esforço o seu site de um link e implantá-lo na sua conta do GitHub.

Demonstração

Uso

1. Crie um repositório

Para começar, siga estas etapas para criar um novo repositório usando este modelo:

1. Clique aqui para criar um novo repositório.
2. Escolha um nome para o seu repositório. Se você deseja que seu site seja implantado em <yourusername>.github.io , nomeie seu repositório <yourusername>.github.io . Como alternativa, você pode escolher qualquer outro nome, como that-other-name , o que resultará na implantação do seu site em <yourusername>.github.io/that-other-name/ .

2. Ativar páginas do github

Depois de criar o repositório, você precisa ativar as páginas do GitHub. Siga estas etapas:

1. Vá para a guia Settings do seu repositório.
2. Navegue até a seção Pages .
3. Escolha GitHub Actions como fonte para suas páginas do Github.
4. Clique em Save para aplicar as alterações.

3. Adicione seus dados

Para personalizar seu site, siga estas etapas:

1. Abra seu repositório em seu editor de texto preferido.
2. Localize o arquivo data.toml e atualize -o com suas informações.

Clique para aprender todas as configurações disponíveis aqui

Informações gerais

• name : Seu nome (por exemplo, "Vahid Al")
• description : Uma breve biografia sobre você (por exemplo, "desenvolvedor de software e apaixonada por criar coisas")
• keywords : Palavras -chave para as palavras -chave Meta Tag (por exemplo, "Python, JavaScript, Go")
• image : o endereço do arquivo do seu avatar. Coloque seu avatar dentro da pasta dist/img/ (por exemplo, "me.jpeg" - observe que o /dist/img/ endereço não está incluído)
• theme : Escolha o tema do seu site: "Dark" ou "Light" (por exemplo, "Dark")
• primary_color : especifique a cor principal do seu site usando um código de cores hexadecimal (por exemplo, "#00897b")
• text_align : especifique o alinhamento de texto para o seu site: "Right", "Left" ou "Center" (por exemplo, "Centro")
• gtag_id : seu ID de rastreamento do Google Analytics (por exemplo, "G-33WB8LVHR6")
• base_url : o URL base do seu site, mencionado em 1. Crie uma etapa do repositório (por exemplo, https://thevahidal.github.io/jake)

Seções

Você pode adicionar várias seções com base nos seus requisitos. Por exemplo, você pode querer uma seção para seus projetos, outra para seus links de mídia social e outra para seus produtos de mercadorias.

Cada seção é definida usando [[sections]] e possui os seguintes componentes:

• title : O título da seção (por exemplo, "Projetos")
• description : Uma breve descrição da seção (por exemplo, "Aqui estão alguns dos meus projetos")
• direction : A direção da seção: "Linha" ou "Coluna" (por exemplo, "Linha")
• item_style : o estilo dos itens na seção: "contorno" ou "preenchido" (por exemplo, "esboço")
• items : os itens associados à seção.

Unid

Cada item é definido usando [[sections.items]] e possui os seguintes componentes:

• title : O título do item (por exemplo, "Soul")
• description : Uma breve descrição do item (por exemplo, "um descanso sqlite e servidor em tempo real")
• url : O URL associado ao item (por exemplo, "https://github.com/thevahidal/soul")

4. Voila

É tudo o que você precisa fazer. Agora, você pode sentar e relaxar enquanto seu site é implantado. Você pode monitorar o progresso na guia Actions do seu repositório. Após a conclusão da implantação, você pode acessar seu novo site de um link em <yourusername>.github.io (se você escolheu <yourusername>.github.io como seu nome de repositório) ou <yourusername>.github.io/repo-name/ .

Perguntas frequentes

1. Como configurar meu próprio domínio personalizado ?

Se você deseja usar seu domínio personalizado para o seu site hospedado em páginas do GitHub, é um processo direto. Basta seguir estas etapas:

1. Vá para a guia Configurações do seu repositório do GitHub.
2. Selecione a guia Páginas na barra lateral.
3. Na seção de domínio personalizado , insira o nome de domínio desejado.
4. Clique em Salvar .

É isso! O site do seu Github Pages agora estará acessível usando seu domínio personalizado.

Para obter instruções e informações mais detalhadas sobre o uso de um domínio personalizado com páginas do GitHub, você pode consultar os documentos oficiais do GitHub.

2. Como acionar manualmente a ação do Github para implantar meu site?

1. No seu repositório, navegue até a guia "Ações".
2. Procure o fluxo de trabalho chamado "Site Jake no GitHub Pages" na lista de fluxos de trabalho.
3. Se você vir um alerta afirmando "Este fluxo de trabalho possui um gatilho de evento Workflow_dispatch", significa que você pode acionar manualmente o fluxo de trabalho.
4. Clique no botão "Executar fluxo de trabalho". Uma nova janela aparecerá.
5. Dentro da nova janela, clique no botão verde "Run Workflow".
6. As ações do GitHub iniciarão o processo de implantação do seu conteúdo estático nas páginas do GitHub.

Contribuindo

Se você encontrar algum problema ou ter sugestões de melhoria, sinta -se à vontade para contribuir enviando uma solicitação de tração ou criando um problema no repositório.

Licença

Este projeto está licenciado sob a licença do MIT.