Skip to content

Commit

Permalink
cleaning up code, removing inconsistent yaml frontmatter
Browse files Browse the repository at this point in the history
  • Loading branch information
toddstoffer committed Dec 2, 2016
1 parent a505da6 commit edab5e8
Show file tree
Hide file tree
Showing 18 changed files with 13 additions and 344 deletions.
31 changes: 2 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,32 +4,5 @@ This template utilizes Jekyll, an open source static website generator, as well
####Why Should I Use This?
By using this template you will have a website that is well designed, easy to maintain, free to host and easy to update. While there are many options out there for personal and professional websites, most are dependant on the platform on which they were built, and cannot be easily migrated. This template, while built for Github Pages integration, provides flexibility should you choose to host it elsewhere.

##First Steps
In order to get started you will need to first create your own Github account by going to [github.com](https://github.com/). You will be prompted to choose an account type, choose the Free account option. After creating your account you will need to create a new repository. **You must name your repository [username].github.io** (replacing [username] with the username of your Github account). If you have any troubles creating a repository please refer to the [Github Pages](https://pages.github.com/) documentation.


![Create a Repository] (https://github.com/toddstoffer/jekyll-academic/blob/master/%20createrepo.gif)

####Copying the Template
Once you have created your new repository you will be taken to a setup page. At the bottom of that page you should see the **Import Code** button. Click on this button. The following page has a place for you to put the URL of an existing repository, copy and paste the following into that space:
`https://github.com/NCSU-Libraries/jekyll-academic`

After the import is complete you can then visit [username].github.io and you will see your newly created website. On this page you will see a variety of posts that contain more detailed information on editing, modifying and updating your new website.

##Next Steps
After you have imported the files into your repository you will want to clone the files to your desktop using GitHub Desktop, or any other tool that you are comfortable with. For more information on using GitHub Desktop click [here](https://desktop.github.com/). This will give you a working set of files that you can edit to personalize your website.

####Editing the config.yaml File
The config.yaml file that is in the root directory of the project is the first file that you will want to edit. This file allows you to set the website title, your email address and add in account information for a variety of social media services.

####Editing the accent.scss File
The accent.scss file allows you to modify the accent colors of your website. The default colors (red and black) can be set to any hexadecimal color that you would like. [W3Schools.com](http://www.w3schools.com/colors/colors_picker.asp) provides a good color picker that allows you to find the corresponding hex number for any color you wish to use.

####Editing the About Me and Resume Pages
These pages are each found in their corresponding directories (/about /resume). Simply open the index.md file from within each of these directories and begin making edits. Pay special attention to the formatting of the resume file. It makes use of single quotes ( \' ) and underscores ( \_ ) in the markdown markup language to format various aspects of the resume, including dates and university names.

####Editing Posts
Posts are all located in the \_posts folder. This folder contains sample posts that address in more depth the site structure and the markdown syntax. These posts are good to reference (by opening in a text editor of your choice) in order to get a better understanding of markdown. When you are ready to add a new post, simply copy one of the existing posts and edit it. Be sure to update the information at the top of the post, such as the title and timestamp. You will also want to rename the file to follow the same naming convention of the other post files (yyyy-mm-dd-post-title.md).

##Syncing Changes
After you have made changes to your site you will need to commit those changes to your repository for those changes to take effect. For more information on making commits please take a look at this [GitHub Cheat Sheet](https://training.github.com/kit/downloads/github-git-cheat-sheet.pdf). If you would prefer, you can also use GitHub Desktop to commit your changes, or drag-and-drop the changed files directly into your GitHub repository in the browser window.
##[Getting Started Guide](http://ncsu-libraries.github.io/jekyll-academic/)
Complete documentation for getting started as well as advanced features of Jekyll Academic can be fount at [http://ncsu-libraries.github.io/jekyll-academic/](http://ncsu-libraries.github.io/jekyll-academic/).
23 changes: 6 additions & 17 deletions _data/authors.yml
100755 → 100644
Original file line number Diff line number Diff line change
@@ -1,20 +1,9 @@
# Authors

billy_rick:
name: Billy Rick
web: http://thewhip.com
email: [email protected]
bio: "What do you want, jewels? I am a very extravagant man."
avatar: bio-photo-2.jpg
twitter: extravagantman
google:
plus: BillyRick

cornelius_fiddlebone:
name: Cornelius Fiddlebone
email: [email protected]
bio: "I ordered what?"
first_author:
name: Author Name
web: http://example.com
email: [email protected]
bio: "Short bio statement"
avatar: bio-photo.jpg
twitter: rhymeswithsackit
google:
plus: CorneliusFiddlebone
twitter:
3 changes: 2 additions & 1 deletion _includes/_footer.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,5 @@
</div><!-- /.google-ads -->
{% endif %}

<span>&copy; {{ site.time | date: '%Y' }} {{ site.owner.name }}. Powered by <a href="http://jekyllrb.com" rel="nofollow">Jekyll</a> using the <a href="http://mademistakes.com/minimal-mistakes/" rel="nofollow">Minimal Mistakes</a> theme.</span>
<span>&copy; {{ site.time | date: '%Y' }} {{ site.owner.name }}. Powered by <a href="http://jekyllrb.com" rel="nofollow">Jekyll</a> using the <a href="http://ncsu-libraries.github.io/jekyll-academic/" rel="nofollow">Jekyll Academic</a> theme.
<br />Based on the <a href="https://mmistakes.github.io/minimal-mistakes/">Minimal Mistakes</a> theme developed by Michael Rose.</span>
99 changes: 0 additions & 99 deletions _posts/2016-02-26-markdown-basics.md

This file was deleted.

98 changes: 0 additions & 98 deletions _posts/2016-02-27-site-setup-and-configuration-.md

This file was deleted.

89 changes: 0 additions & 89 deletions _posts/2016-02-28-editing-your-site.md

This file was deleted.

File renamed without changes.
4 changes: 1 addition & 3 deletions about/index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
---
layout: page
title: About Me
tags: [about, about me, me, ]
modified: 2014-08-08T20:53:07.573882-04:00
comments: true
tags: [about, about me, me]
---

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
Expand Down
3 changes: 0 additions & 3 deletions archive/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
---
layout: post-index
title: All Blog Posts
excerpt: "A List of Posts"
image:
feature: sample-image-1.jpg
---
File renamed without changes
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed images/screencast/ createrepo.gif
Binary file not shown.
7 changes: 2 additions & 5 deletions index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
---
layout: home
excerpt: "A minimal Jekyll theme for your blog by designer Michael Rose."
tags: [Jekyll, theme, responsive, blog, template]
image:
feature: sample-image-1.jpg
---
excerpt: "A Jekyll theme for your blog, resume and portfolio from NCSU Libraries"
---

0 comments on commit edab5e8

Please sign in to comment.