haopengzhan/pengzhan.dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update readme to clarify options

Browse Source
This commit is contained in:
Joel Glovier
2015-07-23 13:55:20 -04:00
parent 9918e205d1
commit 561677ebbb
1 changed files with 14 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+14 -4
View File
@@ -6,10 +6,6 @@
## Docs ## Docs
### Customizing
First you'll want to fork the repo to your own account. Then clone it locally and customize, or use the GitHub web editor to customize. Much Most of the basic customization will take place in the `/_config.yml` file, and most of the content configuration will take place in the `/_layouts/resume.html` file
### Running locally ### Running locally
To test locally, run the following in your terminal: To test locally, run the following in your terminal:
@@ -19,6 +15,20 @@ To test locally, run the following in your terminal:
2. `bundle exec jekyll serve` 2. `bundle exec jekyll serve`
3. Open your browser to `localhost:4000` 3. Open your browser to `localhost:4000`
### Customizing
First you'll want to fork the repo to your own account. Then clone it locally and customize, or use the GitHub web editor to customize.
#### Options/configuration
Much Most of the basic customization will take place in the `/_config.yml` file. Here is a list of customizations available via `/_config.yml`:
[...write these out...]
#### Editing content
Most of the content configuration will take place in the `/_layouts/resume.html` file. Simply edit the markup there accordingly
### Publishing to GitHub Pages for free ### Publishing to GitHub Pages for free
[GitHub Pages](https://pages.github.com/) will host this for free with your GitHub account. Just make sure you're using a `gh-pages` branch, and the site will automatically be available at `yourusername.github.io/resume-template` (you can rename the repo to resume for your own use if you want it to be available at `yourusername.github.io/resume`). You can also add a CNAME if you want it to be available at a custom domain... [GitHub Pages](https://pages.github.com/) will host this for free with your GitHub account. Just make sure you're using a `gh-pages` branch, and the site will automatically be available at `yourusername.github.io/resume-template` (you can rename the repo to resume for your own use if you want it to be available at `yourusername.github.io/resume`). You can also add a CNAME if you want it to be available at a custom domain...