dan
/
jekyll
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

mention `docs` folder to deploy on GitHub Pages 

fix #5543
This commit is contained in:
Frank Taillandier 2016-11-10 23:42:01 +01:00
parent d050f6de10
commit 3e504f0837
1 changed files with 17 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/_docs/github-pages.md
View File

@ -115,21 +115,28 @@ publish the GitHub Pages site, so make sure your Jekyll site is stored there.
Unlike user and organization Pages, Project Pages are kept in the same Unlike user and organization Pages, Project Pages are kept in the same
repository as the project they are for, except that the website content is repository as the project they are for, except that the website content is
stored in a specially named `gh-pages` branch. The content of this branch will stored in a specially named `gh-pages` branch or in a `docs` folder on the
be rendered using Jekyll, and the output will become available under a subpath `master` branch. The content will be rendered using Jekyll, and the output
of your user pages subdomain, such as `username.github.io/project` (unless a will become available under a subpath of your user pages subdomain, such as
custom domain is specified—see below). `username.github.io/project` (unless a custom domain is specified).
The Jekyll project repository itself is a perfect example of this branch The Jekyll project repository itself is a perfect example: the
structure—the [master branch]({{ site.repository }}) contains the [master branch]({{ site.repository }}) contains the actual software project
actual software project for Jekyll, however the Jekyll website (that you’re for Jekyll, however the Jekyll website (that you’re looking at right now) is
looking at right now) is contained in the [gh-pages contained in the [docs folder]({{ site.repository }}/tree/master/docs) of the
branch]({{ site.repository }}/tree/gh-pages) of the same repository. same repository.
Please refer to GitHub official documentation on
[user, organization and projets pages](https://help.github.com/articles/user-organization-and-project-pages/)
to see more detailed examples.
<div class="note warning"> <div class="note warning">
<h5>Source Files Must be in the Root Directory</h5> <h5>Source Files Must be in the Root Directory</h5>
<p> <p>
GitHub Pages <a href="https://help.github.com/articles/troubleshooting-github-pages-build-failures#source-setting">overrides</a> the <a href="/docs/configuration/#global-configuration">“Site Source”</a> configuration value, so if you locate your files anywhere other than the root directory, your site may not build correctly. GitHub Pages <a href="https://help.github.com/articles/troubleshooting-github-pages-build-failures#source-setting">overrides</a>
the <a href="/docs/configuration/#global-configuration">“Site Source”</a>
configuration value, so if you locate your files anywhere other than the
root directory, your site may not build correctly.
</p> </p>
</div> </div>