Merge pull request #64 from jameslvdb/social-media-readme-update
Add social media instructions to README
This commit is contained in:
commit
c8053d803d
2 changed files with 25 additions and 21 deletions
25
README.md
25
README.md
|
@ -80,6 +80,31 @@ Your website comes pre-configured with three topics (e.g. "Web design" and "Sass
|
|||
- `web_url`: The web address you'd like to your topic to link to (e.g. `https://github.com/topics/sass`).
|
||||
- `image_url`: The web address of an (ideally square) image that you'd like to appear with your topic.
|
||||
|
||||
#### Social media
|
||||
|
||||
Your website supports linking and sharing to social media services you're using, including Facebook, Dribbble, LinkedIn, Twitter, and YouTube. To identify the services you use:
|
||||
|
||||
1. Edit your repository's `_config.yml` file.
|
||||
2. Add a `social_media` dictionary line, and represent the services you like in a simple `key: value` form:
|
||||
|
||||
```
|
||||
social_media:
|
||||
facebook: your_username
|
||||
dribbble: your_username
|
||||
linkedin: your_username
|
||||
twitter: your_username
|
||||
youtube: your_username
|
||||
```
|
||||
|
||||
Links to your profile for each of the services you define will appear in the `<header>` of your website, appended to your bio. And if those services support sharing, any blog posts that you publish will include links to share that post using each social media service.
|
||||
|
||||
**Note**: This feature is supported by two files in your repository:
|
||||
|
||||
- `/_data/social_media.yml`: Defines each of the supported services, including variable name, display name, URL path, and SVG icon.
|
||||
- `/_includes/social_media_share_url.html`: Outputs the share URL required for any of the supported social media services that support sharing URLs.
|
||||
|
||||
If you're interested in adding a social media service that's not already supported in this repo, you can edit these two files to build that support.
|
||||
|
||||
## Adding pages
|
||||
|
||||
To **add a page** to your website (e.g. detailed resume):
|
||||
|
|
|
@ -1,21 +0,0 @@
|
|||
# frozen_string_literal: true
|
||||
|
||||
Gem::Specification.new do |spec|
|
||||
spec.name = "github-personal-website"
|
||||
spec.version = "0.1.1"
|
||||
spec.authors = ["Brandon Rosage"]
|
||||
spec.email = ["brandonrosage@github.com"]
|
||||
|
||||
spec.summary = "Jekyll theme for software developers interested in creating a personal website."
|
||||
spec.homepage = "http://github.dev."
|
||||
spec.license = "MIT"
|
||||
|
||||
spec.files = `git ls-files -z`.split("\x0").select do |f|
|
||||
f.match(%r{^(_(includes|layouts|sass)/|(LICENSE|README)((\.(txt|md|markdown)|$)))}i)
|
||||
end
|
||||
|
||||
spec.add_runtime_dependency "jekyll", "~> 3.7"
|
||||
|
||||
spec.add_development_dependency "bundler", "~> 2.0.1"
|
||||
spec.add_development_dependency "rake", "~> 12.0"
|
||||
end
|
Loading…
Reference in a new issue