Prerequisites
Before you can use Jekyll to create a GitHub Pages site, you must install Jekyll and Git. For more information, see Installation in the Jekyll documentation and "Set up Git."
Recomendamos o uso do Bundler para instalar e executar o Jekyll. O Bundler gerencia as dependências do gem do Ruby, reduz os erros de compilação do Jekyll e evita erros relacionados ao ambiente. Para instalar o bundler:
- Instale o Ruby. Para obter mais informações, consulte "Instalar o Ruby" na documentação do Ruby.
- Instale o Bundler. Para obter mais informações, consulte "Bundler".
Dica: se vir um erro do Ruby ao tentar instalar o Jekyll usando o Bundler, talvez você precise usar um gerenciador de pacotes, como o RVM ou Homebrew, para gerenciar a instalação do Ruby. Para obter mais informações, consulte "Solução de problemas" na documentação do Jekyll.
Creating a repository for your site
Se o seu site for um projeto independente, você pode criar um novo repositório para armazenar o código-fonte do seu site. Se o seu site estiver associado a um projeto existente, você pode adicionar o código-fonte a esse repositório do projeto, em uma pasta de /docs
no branch padrão ou em um branch diferente. Por exemplo, se você estiver criando um site para publicar a documentação de um projeto que já está em GitHub Enterprise Server, você deverá armazenar o código-fonte para o site no mesmo repositório do projeto.
Se você deseja criar um site em um repositório existente, pule para a seção "Criar o seu site.
Aviso: Se o administrador do site tiver ativado páginas públicas, GitHub Pages sites estão disponíveis publicamente na internet, Mesmo que o repositório para o site seja privado ou interno. Se tiver dados confidenciais no repositório do seu site, poderá remover os dados antes de publicar. Para mais informações, consulteConfigurando GitHub Pages para a sua empresa" e "Sobre a visibilidade do repositório."
- No canto superior direito de qualquer página, use o menu suspenso e selecione Novo repositório.
- Use o menu suspenso Proprietário e selecione a conta que você deseja que seja proprietária do repositório.
- Digite um nome para o repositório e uma descrição opcional. Se você estiver criando um site de usuário ou organização, o seu repositório deve ser denominado
<user>.github.io
ou<organization>.github.io
. Para obter mais informações, consulte "Sobre GitHub Pages". - Escolha uma visibilidade do repositório. Para obter mais informações, consulte "Sobre a visibilidade do repositório."
Creating your site
Antes de criar seu site, você deve ter um repositório para seu site no GitHub Enterprise Server. Se você não estiver criando o site em um repositório existente, consulte "Criar um repositório para o site".
-
Abra TerminalTerminalGit Bash.
-
If you don't already have a local copy of your repository, navigate to the location where you want to store your site's source files, replacing PARENT-FOLDER with the folder you want to contain the folder for your repository.
$ cd PARENT-FOLDER
-
If you haven't already, initialize a local Git repository, replacing REPOSITORY-NAME with the name of your repository.
$ git init REPOSITORY-NAME > Initialized empty Git repository in /Users/octocat/my-site/.git/ # Creates a new folder on your computer, initialized as a Git repository
-
Change directories to the repository.
$ cd REPOSITORY-NAME # Changes the working directory
-
If you're creating a project site, decide which publishing source you want to use. If you're creating a user or organization site, you must store your site's source code on the
master
branch. For more information, see "About GitHub Pages." -
Navegue até a fonte de publicação do seu site. Para obter mais informações sobre fontes de publicação, consulte "Sobre o GitHub Pages". For example, if you chose to publish your site from the
docs
folder on the default branch, create and change directories to thedocs
folder.$ mkdir docs # Creates a new folder called docs $ cd docs
If you chose to publish your site from the
gh-pages
branch, create and checkout thegh-pages
branch.$ git checkout --orphan gh-pages # Creates a new branch, with no history or contents, called gh-pages and switches to the gh-pages branch
-
To create a new Jekyll site, use the
jekyll new
command, replacing VERSION with the current dependency version for Jekyll. For more information, see "Dependency versions" on the GitHub Pages site.- If you installed Bundler:
$ bundle exec jekyll VERSION new . # Creates a Jekyll site in the current directory
- If you don't have Bundler installed:
$ jekyll VERSION new . # Creates a Jekyll site in the current directory
- If you installed Bundler:
-
Open the Gemfile that was created and follow the instructions in the Gemfile's comments to use GitHub Pages.
-
Update the
gem "github-pages"
line so that the line looks like this, replacing VERSION with the current dependency version forgithub-pages
. For more information, see "Dependency versions" on the GitHub Pages site.gem "github-pages", "~> VERSION", group: :jekyll_plugins
-
Save and close the Gemfile.
-
Optionally, test your site locally. For more information, see "Testing your GitHub Pages site locally with Jekyll."
-
Add your GitHub Enterprise Server repository as a remote, replacing HOSTNAME with your enterprise's hostname, USER with the account that owns the repository, and REPOSITORY with the name of the repository.
$ git remote add origin https://HOSTNAME/USER/REPOSITORY.git
-
Push the repository to GitHub Enterprise Server, replacing BRANCH with the name of the branch you're working on.
$ git push -u origin BRANCH
-
Configure a sua fonte de publicação. Para obter mais informações, consulte "Configurar uma fonte de publicação para seu site do GitHub Pages".
-
Em GitHub Enterprise Server, acesse o repositório do seu site.
-
No nome do seu repositório, clique em Configurações.
-
Para ver seu site publicado, em "GitHub Pages", clique na URL do seu site.
Observação: podem ser necessários até 20 minutos para que as alterações no site sejam publicadas após o push delas no GitHub Enterprise Server. Se você não vir suas alterações no navegador após uma hora, consulte "Sobre erros de criação do Jekyll para sites de GitHub Pages".
Observação: Se os arquivos de origem de do site estão localizados na fonte de publicação padrão —mestre
para sites de usuário e organização ou gh-pages
para sites de projeto — mas seu site não fez a publicação automaticamente, certifique-se de que alguém com permissões de administrador e um endereço de e-mail verificado tenha feito push para a fonte de publicação.
Next steps
To add a new page or post to your site, see "Adding content to your GitHub Pages site using Jekyll."
É possível adicionar um tema do Jekyll ao site do GitHub Pages para personalizar a aparência do seu site. For more information, see "Adding a theme to your GitHub Pages site using Jekyll."