diff --git a/websiteFiles/404.html b/404.html similarity index 100% rename from websiteFiles/404.html rename to 404.html diff --git a/websiteFiles/LICENSE.md b/LICENSE.md similarity index 100% rename from websiteFiles/LICENSE.md rename to LICENSE.md diff --git a/websiteFiles/_config.yml b/_config.yml similarity index 78% rename from websiteFiles/_config.yml rename to _config.yml index 984ccb3..3b910e1 100644 --- a/websiteFiles/_config.yml +++ b/_config.yml @@ -1,26 +1,17 @@ -# Dependencies -markdown: kramdown -highlighter: rouge - -# Permalinks -permalink: pretty - -# Setup +# Personalize your website info here title: Anew Guy tagline: 'Professional Website for Anew Guy' description: 'Website and Blog for Anew Guy' url: http://anewguy.github.io -baseurl: / - author: name: 'Anew Guy' url: https://twitter.com/anewguy +## You don't need to modify below this line paginate: 5 # Custom vars version: 2.1.0 - github: repo: https://github.com/poole/hyde @@ -28,4 +19,10 @@ gems: [jekyll-paginate,jekyll-gist, redcarpet] paginate: 5 paginate_path: "page:num" -markdown: kramdown +# Dependencies +markdown: kramdown +highlighter: rouge + +# Permalinks +permalink: pretty +baseurl: https://biodata-club.github.io/githubPagesTutorial/ diff --git a/websiteFiles/_includes/head.html b/_includes/head.html similarity index 100% rename from websiteFiles/_includes/head.html rename to _includes/head.html diff --git a/websiteFiles/_includes/sidebar.html b/_includes/sidebar.html similarity index 98% rename from websiteFiles/_includes/sidebar.html rename to _includes/sidebar.html index 586f47b..4017151 100644 --- a/websiteFiles/_includes/sidebar.html +++ b/_includes/sidebar.html @@ -1,11 +1,11 @@
{{ site.description }}
+```
+
+
+## Useful Links
+
+The world is now your oyster now that you've mastered GitHub Pages and Markdown.
+
++ GitHub Pages: [https://pages.github.com](https://pages.github.com)
++ Jekyll Themes: [http://jekyllthemes.org](http://jekyllthemes.org)
+
+Markdown is not only useful for GitHub Pages. One markdown document can be translated into PDFs, HTML Slides, Word Documents, and a bunch of other formats. We talk about some of the uses here: [http://laderast.github.io/magic-of-markdown/](http://laderast.github.io/magic-of-markdown/)
diff --git a/easy/dummyFile b/easy/dummyFile
new file mode 100644
index 0000000..8b13789
--- /dev/null
+++ b/easy/dummyFile
@@ -0,0 +1 @@
+
diff --git a/websiteFiles/index.html b/index.html
similarity index 100%
rename from websiteFiles/index.html
rename to index.html
diff --git a/websiteFiles/public/apple-touch-icon-144-precomposed.png b/public/apple-touch-icon-144-precomposed.png
similarity index 100%
rename from websiteFiles/public/apple-touch-icon-144-precomposed.png
rename to public/apple-touch-icon-144-precomposed.png
diff --git a/websiteFiles/public/css/hyde.css b/public/css/hyde.css
similarity index 100%
rename from websiteFiles/public/css/hyde.css
rename to public/css/hyde.css
diff --git a/websiteFiles/public/css/poole.css b/public/css/poole.css
similarity index 100%
rename from websiteFiles/public/css/poole.css
rename to public/css/poole.css
diff --git a/websiteFiles/public/css/syntax.css b/public/css/syntax.css
similarity index 100%
rename from websiteFiles/public/css/syntax.css
rename to public/css/syntax.css
diff --git a/websiteFiles/public/favicon.ico b/public/favicon.ico
similarity index 100%
rename from websiteFiles/public/favicon.ico
rename to public/favicon.ico
diff --git a/readme.md b/readme.md
index 1433291..26fe63f 100644
--- a/readme.md
+++ b/readme.md
@@ -1,17 +1,118 @@
-## GitHub Pages Tutorial
+# Hyde
-Welcome to the GitHub Pages Tutorial!
+Hyde is a brazen two-column [Jekyll](http://jekyllrb.com) theme that pairs a prominent sidebar with uncomplicated content. It's based on [Poole](http://getpoole.com), the Jekyll butler.
-With a text editor and the GitHub Desktop, you can start your own personal website on GitHub. Bring your laptop and we'll explore the fun world of GitHub Pages!
+
-Things you need to do before you can start:
- 1) A [Github Account](https://github.com/join?source=header-home)
- 2) Download the GitHub Desktop App
- 3) A Good Text Editor ([Sublime](https://www.sublimetext.com) or [Atom](https://atom.io) are good ones)
- 4) Something to say
- 5) Photos (optional)
+## Contents
-## Attribution
-
-This tutorial uses Mark Otto's [Hyde Template for Jekyll](http://hyde.getpoole.com) with some simple modifications to make it Jeykll 3.0 Compatible
\ No newline at end of file
+- [Usage](#usage)
+- [Options](#options)
+ - [Sidebar menu](#sidebar-menu)
+ - [Sticky sidebar content](#sticky-sidebar-content)
+ - [Themes](#themes)
+ - [Reverse layout](#reverse-layout)
+- [Development](#development)
+- [Author](#author)
+- [License](#license)
+
+
+## Usage
+
+Hyde is a theme built on top of [Poole](https://github.com/poole/poole), which provides a fully furnished Jekyll setup—just download and start the Jekyll server. See [the Poole usage guidelines](https://github.com/poole/poole#usage) for how to install and use Jekyll.
+
+
+## Options
+
+Hyde includes some customizable options, typically applied via classes on the `` element.
+
+
+### Sidebar menu
+
+Create a list of nav links in the sidebar by assigning each Jekyll page the correct layout in the page's [front-matter](http://jekyllrb.com/docs/frontmatter/).
+
+```
+---
+layout: page
+title: About
+---
+```
+
+**Why require a specific layout?** Jekyll will return *all* pages, including the `atom.xml`, and with an alphabetical sort order. To ensure the first link is *Home*, we exclude the `index.html` page from this list by specifying the `page` layout.
+
+
+### Sticky sidebar content
+
+By default Hyde ships with a sidebar that affixes it's content to the bottom of the sidebar. You can optionally disable this by removing the `.sidebar-sticky` class from the sidebar's `.container`. Sidebar content will then normally flow from top to bottom.
+
+```html
+
+-Ted Laderas (laderast@ohsu.edu), Eric Leung, and Robin Champieux -
-4/5/2017
-GitHub Pages is a built-in system that allows you to build websites directly from a GitHub Repository.
-There are two kinds of GitHub pages:
-You don’t need to know how to code to setup a GitHub page. We’ll learn some Markdown basics
-GitHub is a highly dependable webhost, and you get one personal webpage account for free.
-Because GitHub pages is compatible with markdown, we’ll be using markdown formatting to build our webpage.
-If you have a GitHub account with USERNAME, you can serve a webpage directly from USERNAME.github.io. For example: http://laderast.github.io
-You first need to create a repository with that name. From GitHub Desktop, click the “+” symbol, and create a new repository.
-When you’ve created the repository, “publish” it to GitHub.
-Once you’ve published the repository, try your personal webpage: http://USERNAME.github.io
-We are first going to rename the websiteFiles directory to match the name of your webpage repo.
The first step to customizing your webpage is to edit the blogs name to include your information. You’ll open the _config.yml file to update the info.
Here’s an example _config.yml file.
Anything with index.md will be automatically translated and served as a webpage.
-Using Jekyll, you can add header and footers and other templating features, standardizing the look of your pages as you like.
-One thing to remember is when your output is html, you can embed HTML tags, which is especially useful for embedding images, since you can adjust image size directly within the tag.
-Your current repository is setup for blog entries.
-Another nice use of Markdown is for authoring websites. You can do this really easily with GitHub pages.
-GitHub Pages uses an HTML translation engine called Jekyll, which is written in Ruby to translate Markdown into HTML. You don’t really need to know about it, unless you want to use the templating in Jekyll to build something like a blog.
-One benefit to using Jekyll is that it’s a relatively lightweight way to manage a blog without a more complicated, database-using, content management system. Because of this, it’s relatively portable and you can easily take your documents with you if you decide to migrate to another system.
-Any markdown file that has an .markdown or .md extension will automatically be processed by GitHub and served as a html page. For example: https://github.com/laderast/magic-of-markdown/blob/master/magic-of-markdown.md
-If you want to make a webpage for your code, you need to create a branch called gh-pages and put the markdown files in there. I believe you can also just place html files as well.
If you’re interested in setting up a blog or more complicated site, you’ll have to learn a little bit about Jekyll and the liquid templating language.
-You can download Jekyll by itself to see how it transforms markdown files, but to get started with a blog or pages, it’s actually way easier to clone Poole, which gives you the basic file structure that you can use to serve the GitHub pages.
-