1
0
mirror of synced 2026-01-31 09:01:33 -05:00
Files
docs/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md
jmarlena eca5b64ed5 GitHub Pages workflow runs for every GitHub Pages site (#22797)
* Add section about GitHub Pages workflow run

* Create a reusable step for checking workflow run

* Add a public beta reusable note

* Add new reusable for checking workflows for build errors

* Add new reusable and new sections to this article

* Add that space

* Convert reusable to regular text

* Add alternate CI caveat to reusable

* Playing with spacing

* Change versioning to fpt only

* Fix formatting for reusable with note

* Add troubleshooting detail

* Apply suggestions from code review

Co-authored-by: Yoann Chaudet <yoannchaudet@github.com>

* Apply suggestions from code review

* Reframe step without resuable

* Remove resuable for now

* Apply suggestions from code review

Co-authored-by: Sarah Edwards <skedwards88@github.com>

* Apply suggestions from code review

* Revamp the reusables

* Apply suggestions from code review

Co-authored-by: Sarah Edwards <skedwards88@github.com>

* Apply suggestions from code review

* Apply suggestions from code review

Co-authored-by: Tommy Byrd <tcbyrd@github.com>

Co-authored-by: “jmarlena” <“jmarlena@github.com”>
Co-authored-by: Octomerger Bot <63058869+Octomerger@users.noreply.github.com>
Co-authored-by: Yoann Chaudet <yoannchaudet@github.com>
Co-authored-by: Sarah Edwards <skedwards88@github.com>
Co-authored-by: Tommy Byrd <tcbyrd@github.com>
2021-12-16 19:22:15 +00:00

3.8 KiB
Raw Blame History

title, intro, redirect_from, product, versions, topics, shortTitle
title intro redirect_from product versions topics shortTitle
Creating a GitHub Pages site You can create a {% data variables.product.prodname_pages %} site in a new or existing repository.
/articles/creating-pages-manually/
/articles/creating-project-pages-manually/
/articles/creating-project-pages-from-the-command-line/
/articles/creating-project-pages-using-the-command-line/
/articles/creating-a-github-pages-site
/github/working-with-github-pages/creating-a-github-pages-site
{% data reusables.gated-features.pages %}
fpt ghes ghae ghec
* * * *
Pages
Create a GitHub Pages site

{% data reusables.pages.org-owners-can-restrict-pages-creation %}

Creating a repository for your site

{% data reusables.pages.new-or-existing-repo %}

{% data reusables.repositories.create_new %} {% data reusables.repositories.owner-drop-down %} {% data reusables.pages.create-repo-name %} {% data reusables.repositories.choose-repo-visibility %} {% data reusables.repositories.initialize-with-readme %} {% data reusables.repositories.create-repo %}

Creating your site

{% data reusables.pages.must-have-repo-first %}

{% data reusables.pages.private_pages_are_public_warning %}

{% data reusables.pages.navigate-site-repo %} {% data reusables.pages.decide-publishing-source %} 3. If your chosen publishing source already exists, navigate to the publishing source. If your chosen publishing source doesn't exist, create the publishing source. 4. In the root of the publishing source, create a new file called index.md that contains the content you want to display on the main page of your site.

{% tip %}

Tip: If index.html is present, this will be used instead of index.md. If neither index.html nor index.md are present, README.md will be used.

{% endtip %} {% data reusables.pages.configure-publishing-source %} {% data reusables.repositories.sidebar-settings %} {% data reusables.pages.sidebar-pages %}{% ifversion fpt or ghec %} {% data reusables.pages.choose-visibility %}{% endif %} {% data reusables.pages.visit-site %} {% data reusables.pages.check-workflow-run %}

{% data reusables.pages.admin-must-push %}

Next steps

You can add more pages to your site by creating more new files. Each file will be available on your site in the same directory structure as your publishing source. For example, if the publishing source for your project site is the gh-pages branch, and you create a new file called /about/contact-us.md on the gh-pages branch, the file will be available at {% ifversion fpt or ghec %}https://<user>.github.io/<repository>/{% else %}http(s):///pages///{% endif %}about/contact-us.html`.

You can also add a theme to customize your sites look and feel. For more information, see {% ifversion fpt or ghec %}"Adding a theme to your {% data variables.product.prodname_pages %} site with the theme chooser{% else %}"Adding a theme to your {% data variables.product.prodname_pages %} site using Jekyll{% endif %}."

To customize your site even more, you can use Jekyll, a static site generator with built-in support for {% data variables.product.prodname_pages %}. For more information, see "About {% data variables.product.prodname_pages %} and Jekyll."

Further reading