theme.thephpleague.com

KO | EN

gitlite — search

#javascript #python #typescript #llm #go #golang #android #docker #nodejs #windows #awesome-list #pytorch #security #open-source

theme.thephpleague.com

(★ 12)

No description available.

theme.thephpleague.com Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Quick-start guide

The following document explains how to quickly generate a fully responsive, branded project website for The PHP League. These sites are created using [Jekyll](https://jekyllrb.com/) and are designed to be hosted on [GitHub Pages](https://pages.github.com/).

## Install Jekyll

If you do not yet have Jekyll installed, [do that first](https://jekyllrb.com/docs/installation/).

## Create gh-pages branch

Go to your project folder.

~~~bash
cd your-project-folder
~~~

Create an orphaned [gh-pages](https://help.github.com/articles/creating-project-pages-manually) branch and remove all files from the old working tree.

~~~bash
git checkout --orphan gh-pages
git rm -rf .
~~~

If you already have a gh-pages branch, simply switch to it.

~~~bash
git checkout gh-pages
~~~

## Install the theme

The following [script](https://github.com/thephpleague/theme.thephpleague.com/blob/gh-pages/scripts/create.php) will add the necessary files and folders for the website theme. It will **NOT** overwrite or delete any existing files.

~~~bash
php -r "readfile('https://raw.githubusercontent.com/thephpleague/theme.thephpleague.com/gh-pages/scripts/create.php');" | php
~~~

The basic file stucture looks like this:

~~~
├── _data
│   ├── images.yml
│   ├── menu.yml
│   └── project.yml
├── _layouts
│   └── default.html
├── .gitignore
├── CNAME
└── index.md
~~~

## Build your website

View the Jekyll documentation [here](http://jekyllrb.com/docs/home/). Be sure to add your site specific settings to the config files found in the `_data` folder. Also add your domain name to the `CNAME` file.

~~~bash
jekyll serve --watch
~~~

View your development site at [localhost:4000](http://localhost:4000).

## Commit and deploy

When you're ready to deploy your website, simply push it to the `gh-pages` branch of your GitHub project. You do not need to commit the compiled website, as GitHub Pages does this automatically.

~~~bash
git add -A
git commit -m "Inital commit"
git push origin gh-pages
~~~

theme.thephpleague.com

theme.thephpleague.com Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

theme.thephpleague.com

theme.thephpleague.com Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README