Move gh-pages to docs/

The files in the root directory are the gem or repository files only. All other files related to GitHub Pages hosting are now moved to a separate directory "docs/". The directory structure was refactored to match the new changes. docs/ contains two configuration files: - _config.yml : used for GitHub Pages hosting. - _config.dev.yml : used for local development. To run the theme locally use the following commands: gem build portfolyou-jekyll-theme.gemspec cd docs/ bundle install bundle exec jekyll serve --config _config.dev.yml
kashyap-aditya · Jan 18, 2020 · 3500121 · 3500121
1 parent 00bbb10
commit 3500121
Show file tree

Hide file tree

Showing 80 changed files with 80 additions and 22 deletions.
diff --git a/Gemfile b/Gemfile
diff --git a/README.md b/README.md
@@ -12,6 +12,6 @@
 
 [![Get the theme][button]](https://youssefraafatnasry.github.io/portfolYOU/docs#installation)
 
-[header]: https://github.com/YoussefRaafatNasry/portfolYOU/blob/master/docs/assets/Logo.png?raw=true
-[preview]: https://github.com/YoussefRaafatNasry/portfolYOU/blob/master/docs/assets/Preview.gif?raw=true
-[button]: https://github.com/YoussefRaafatNasry/portfolYOU/blob/master/docs/assets/Button.png?raw=true
+[header]: https://github.com/YoussefRaafatNasry/portfolYOU/blob/master/imgs/Logo.png?raw=true
+[preview]: https://github.com/YoussefRaafatNasry/portfolYOU/blob/master/imgs/Preview.gif?raw=true
+[button]: https://github.com/YoussefRaafatNasry/portfolYOU/blob/master/imgs/Button.png?raw=true
diff --git a/docs/Gemfile b/docs/Gemfile
@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem "portfolyou-jekyll-theme",  path: "../"
diff --git a/docs/_config.dev.yml b/docs/_config.dev.yml
@@ -0,0 +1,64 @@
+### Site Settings ###
+title               : portfolYOU-dev
+description         : Running in Dev Mode
+baseurl             : "/portfolYOU"
+repository          : YoussefRaafatNasry/portfolYOU
+theme               : portfolyou-jekyll-theme
+
+
+### Navbar Settings ###
+nav_exclude:
+  - pages/404.html
+  - pages/index.md
+  - blog/tags.html
+  - blog/page-:num/index.html
+  - pages/documentation/**
+
+
+### Author Info ###
+author:
+  name              : John Doe
+  image             : https://bit.ly/2KCvgVJ
+  github            : your_username
+
+
+### Pagination ###
+paginate: 6
+paginate_path: "/blog/page-:num/"
+
+
+### Posts Permalink ###
+permalink: blog/:title
+
+
+### Collections ###
+collections:
+  projects:
+    output: true
+    permalink: /projects/:name
+  elements:
+    output: true
+
+
+### Defaults for collections ###
+defaults:
+  - scope:
+      path: ""
+      type: "projects"
+    values:
+      layout: "page"
+  - scope:
+      path: ""
+      type: "elements"
+    values:
+      layout: "element"
+
+
+### Plugins ###
+plugins:
+  - jekyll-default-layout
+  - jekyll-gist
+  - jekyll-github-metadata
+  - jekyll-include-cache
+  - jekyll-paginate
+  - jemoji
diff --git a/_config.yml → docs/_config.yml b/_config.yml → docs/_config.yml
@@ -8,16 +8,15 @@ description         : >-                               # >- means to ignore newl
 url                 : ""                               # base hostname & protocol for your site (e.g. http://example.com)
 baseurl             : "/portfolYOU"                    # subpath of your site (e.g. /blog) [IMPORTANT: use "" if your are hosting at https://username.github.io directly]
 repository          : YoussefRaafatNasry/portfolYOU    # repository metadata on GitHub Pages [know more at https://help.github.com/en/articles/repository-metadata-on-github-pages]
-#remote_theme       : YoussefRaafatNasry/portfolYOU    # uncomment this if you are using it as a remote theme
-
+remote_theme        : YoussefRaafatNasry/portfolYOU    # uncomment this if you are using it as a remote theme
 
 ### Navbar Settings ###
 nav_exclude:                        # Pages with the following paths will be excluded from navbar
-  - 404.html
-  - index.html
+  - pages/404.html
+  - pages/index.md
   - blog/tags.html
   - blog/page-:num/index.html
-  - docs/partials/**
+  - pages/documentation/**
 
 
 ### Author Info ###
@@ -60,6 +59,7 @@ collections:
   elements:
     output: true
 
+
 ### Defaults for collections ###
 defaults:
   - scope:
@@ -76,11 +76,6 @@ defaults:
 
 ### Plugins ###
 plugins:
-  - jekyll-default-layout
-  - jekyll-gist
-  - jekyll-github-metadata
-  - jekyll-include-cache
-  - jekyll-paginate
   - jemoji
 
 
@@ -89,6 +84,4 @@ exclude:
   - README.md
   - CONTRIBUTING.md
   - LICENSE
-  - Gemfile
-  - portfolyou-jekyll-theme.gemspec
   - "*.log"
diff --git a/_data/other-skills.yml → docs/_data/other-skills.yml b/_data/other-skills.yml → docs/_data/other-skills.yml
diff --git a/_data/programming-skills.yml → docs/_data/programming-skills.yml b/_data/programming-skills.yml → docs/_data/programming-skills.yml
diff --git a/_data/social-media.yml → docs/_data/social-media.yml b/_data/social-media.yml → docs/_data/social-media.yml
diff --git a/_data/timeline.yml → docs/_data/timeline.yml b/_data/timeline.yml → docs/_data/timeline.yml
diff --git a/_elements/01-headers.html → docs/_elements/01-headers.html b/_elements/01-headers.html → docs/_elements/01-headers.html
diff --git a/_elements/02-emphasis.html → docs/_elements/02-emphasis.html b/_elements/02-emphasis.html → docs/_elements/02-emphasis.html
diff --git a/_elements/03-highlight.html → docs/_elements/03-highlight.html b/_elements/03-highlight.html → docs/_elements/03-highlight.html
diff --git a/_elements/04-blockquotes.html → docs/_elements/04-blockquotes.html b/_elements/04-blockquotes.html → docs/_elements/04-blockquotes.html
diff --git a/_elements/05-links.html → docs/_elements/05-links.html b/_elements/05-links.html → docs/_elements/05-links.html
diff --git a/_elements/06-line-breaks.html → docs/_elements/06-line-breaks.html b/_elements/06-line-breaks.html → docs/_elements/06-line-breaks.html
diff --git a/_elements/07-horizontal-rule.html → docs/_elements/07-horizontal-rule.html b/_elements/07-horizontal-rule.html → docs/_elements/07-horizontal-rule.html
diff --git a/_elements/08-code.html → docs/_elements/08-code.html b/_elements/08-code.html → docs/_elements/08-code.html
diff --git a/_elements/09-syntax-highlighting.html → docs/_elements/09-syntax-highlighting.html b/_elements/09-syntax-highlighting.html → docs/_elements/09-syntax-highlighting.html
diff --git a/_elements/10-github-gists.html → docs/_elements/10-github-gists.html b/_elements/10-github-gists.html → docs/_elements/10-github-gists.html
diff --git a/_elements/11-buttons.html → docs/_elements/11-buttons.html b/_elements/11-buttons.html → docs/_elements/11-buttons.html
diff --git a/_elements/12-ordered-list.html → docs/_elements/12-ordered-list.html b/_elements/12-ordered-list.html → docs/_elements/12-ordered-list.html
diff --git a/_elements/13-unordered-list.html → docs/_elements/13-unordered-list.html b/_elements/13-unordered-list.html → docs/_elements/13-unordered-list.html
diff --git a/_elements/14-list-group.html → docs/_elements/14-list-group.html b/_elements/14-list-group.html → docs/_elements/14-list-group.html
diff --git a/_elements/15-table-of-contents.html → docs/_elements/15-table-of-contents.html b/_elements/15-table-of-contents.html → docs/_elements/15-table-of-contents.html
diff --git a/_elements/16-images.html → docs/_elements/16-images.html b/_elements/16-images.html → docs/_elements/16-images.html
diff --git a/_elements/17-figures.html → docs/_elements/17-figures.html b/_elements/17-figures.html → docs/_elements/17-figures.html
diff --git a/_elements/18-carousel.html → docs/_elements/18-carousel.html b/_elements/18-carousel.html → docs/_elements/18-carousel.html
diff --git a/_elements/19-videos.html → docs/_elements/19-videos.html b/_elements/19-videos.html → docs/_elements/19-videos.html
diff --git a/_elements/20-tables.html → docs/_elements/20-tables.html b/_elements/20-tables.html → docs/_elements/20-tables.html
diff --git a/...015-09-25-how-to-undo-your-git-failure.md → ...015-09-25-how-to-undo-your-git-failure.md b/...015-09-25-how-to-undo-your-git-failure.md → ...015-09-25-how-to-undo-your-git-failure.md
diff --git a/_posts/2016-02-09-what-is-version-control.md → ...sts/2016-02-09-what-is-version-control.md b/_posts/2016-02-09-what-is-version-control.md → ...sts/2016-02-09-what-is-version-control.md
diff --git a/...-do-not-go-gentle-into-that-good-night.md → ...-do-not-go-gentle-into-that-good-night.md b/...-do-not-go-gentle-into-that-good-night.md → ...-do-not-go-gentle-into-that-good-night.md
diff --git a/_posts/2016-07-23-a-better-hello-world.md → ..._posts/2016-07-23-a-better-hello-world.md b/_posts/2016-07-23-a-better-hello-world.md → ..._posts/2016-07-23-a-better-hello-world.md
diff --git a/_posts/2017-01-01-github-flow.md → docs/_posts/2017-01-01-github-flow.md b/_posts/2017-01-01-github-flow.md → docs/_posts/2017-01-01-github-flow.md
diff --git a/...s-after-eleven-years-in-silicon-valley.md → ...s-after-eleven-years-in-silicon-valley.md b/...s-after-eleven-years-in-silicon-valley.md → ...s-after-eleven-years-in-silicon-valley.md
diff --git a/...2018-12-01-what-the-heck-is-a-callback.md → ...2018-12-01-what-the-heck-is-a-callback.md b/...2018-12-01-what-the-heck-is-a-callback.md → ...2018-12-01-what-the-heck-is-a-callback.md
diff --git a/_posts/2018-12-10-clean-coding.md → docs/_posts/2018-12-10-clean-coding.md b/_posts/2018-12-10-clean-coding.md → docs/_posts/2018-12-10-clean-coding.md
diff --git a/_posts/2019-02-15-learn-react-js.md → docs/_posts/2019-02-15-learn-react-js.md b/_posts/2019-02-15-learn-react-js.md → docs/_posts/2019-02-15-learn-react-js.md
diff --git a/_posts/2019-02-20-digital-minimalism.md → docs/_posts/2019-02-20-digital-minimalism.md b/_posts/2019-02-20-digital-minimalism.md → docs/_posts/2019-02-20-digital-minimalism.md
diff --git a/_projects/(1) PlaceHolder Project.md → docs/_projects/(1) PlaceHolder Project.md b/_projects/(1) PlaceHolder Project.md → docs/_projects/(1) PlaceHolder Project.md
diff --git a/_projects/(2) Awesome Project.md → docs/_projects/(2) Awesome Project.md b/_projects/(2) Awesome Project.md → docs/_projects/(2) Awesome Project.md
diff --git a/_projects/(3) Empty Project.md → docs/_projects/(3) Empty Project.md b/_projects/(3) Empty Project.md → docs/_projects/(3) Empty Project.md
diff --git a/_projects/(4) VVG on GitHub.md → docs/_projects/(4) VVG on GitHub.md b/_projects/(4) VVG on GitHub.md → docs/_projects/(4) VVG on GitHub.md
diff --git a/_projects/(5) The Fabulous.md → docs/_projects/(5) The Fabulous.md b/_projects/(5) The Fabulous.md → docs/_projects/(5) The Fabulous.md
diff --git a/_projects/(6) Dummy Project.md → docs/_projects/(6) Dummy Project.md b/_projects/(6) Dummy Project.md → docs/_projects/(6) Dummy Project.md
diff --git a/blog/index.html → docs/blog/index.html b/blog/index.html → docs/blog/index.html
diff --git a/blog/tags.html → docs/blog/tags.html b/blog/tags.html → docs/blog/tags.html
diff --git a/404.html → docs/pages/404.html b/404.html → docs/pages/404.html
@@ -1,4 +1,5 @@
 ---
+permalink: /404.html
 ---
 
 <!DOCTYPE html>

diff --git a/pages/about.md → docs/pages/about.md b/pages/about.md → docs/pages/about.md
diff --git a/docs/docs.md → docs/pages/docs.md b/docs/docs.md → docs/pages/docs.md
@@ -8,10 +8,9 @@ weight: 5
 # About portfolYOU <small class="text-muted">{{ site.github.latest_release.tag_name }}</small>
 {:.no_toc}
 
-{%- assign partials = site.static_files | where_exp:"file", "file.path contains 'docs/partials/'" -%}
-
-{% for partial in partials %}
-{% include_relative {{ partial.path | remove: '/docs/' }} %}
+{%- assign docs = site.static_files | where_exp:"file", "file.path contains '/documentation/'" -%}
+{% for doc in docs %}
+{% include_relative {{ doc.path | remove: '/pages/' }} %}
 {% endfor %}
 
 {% include elements/github-edit-footer.html %}
diff --git a/docs/partials/00-common/01-repo-buttons.html → ...umentation/00-common/01-repo-buttons.html b/docs/partials/00-common/01-repo-buttons.html → ...umentation/00-common/01-repo-buttons.html
diff --git a/docs/partials/00-common/02-description.md → ...documentation/00-common/02-description.md b/docs/partials/00-common/02-description.md → ...documentation/00-common/02-description.md
diff --git a/docs/partials/00-common/03-toc.md → docs/pages/documentation/00-common/03-toc.md b/docs/partials/00-common/03-toc.md → docs/pages/documentation/00-common/03-toc.md
diff --git a/docs/partials/01-features.md → docs/pages/documentation/01-features.md b/docs/partials/01-features.md → docs/pages/documentation/01-features.md
diff --git a/docs/partials/02-installation.md → docs/pages/documentation/02-installation.md b/docs/partials/02-installation.md → docs/pages/documentation/02-installation.md
diff --git a/...rtials/02-installation/01-github-pages.md → ...tation/02-installation/01-github-pages.md b/...rtials/02-installation/01-github-pages.md → ...tation/02-installation/01-github-pages.md
diff --git a/docs/partials/02-installation/02-fork.md → .../documentation/02-installation/02-fork.md b/docs/partials/02-installation/02-fork.md → .../documentation/02-installation/02-fork.md
diff --git a/docs/partials/03-sections.md → docs/pages/documentation/03-sections.md b/docs/partials/03-sections.md → docs/pages/documentation/03-sections.md
diff --git a/docs/partials/04-customization.md → docs/pages/documentation/04-customization.md b/docs/partials/04-customization.md → docs/pages/documentation/04-customization.md
diff --git a/docs/partials/05-adding-content.md → .../pages/documentation/05-adding-content.md b/docs/partials/05-adding-content.md → .../pages/documentation/05-adding-content.md
diff --git a/...ls/05-adding-content/01-local-projects.md → ...on/05-adding-content/01-local-projects.md b/...ls/05-adding-content/01-local-projects.md → ...on/05-adding-content/01-local-projects.md
diff --git a/...s/05-adding-content/02-remote-projects.md → ...n/05-adding-content/02-remote-projects.md b/...s/05-adding-content/02-remote-projects.md → ...n/05-adding-content/02-remote-projects.md
diff --git a/docs/partials/05-adding-content/03-posts.md → ...cumentation/05-adding-content/03-posts.md b/docs/partials/05-adding-content/03-posts.md → ...cumentation/05-adding-content/03-posts.md
diff --git a/docs/partials/05-adding-content/04-pages.md → ...cumentation/05-adding-content/04-pages.md b/docs/partials/05-adding-content/04-pages.md → ...cumentation/05-adding-content/04-pages.md
diff --git a/.../05-adding-content/05-external-content.md → .../05-adding-content/05-external-content.md b/.../05-adding-content/05-external-content.md → .../05-adding-content/05-external-content.md
diff --git a/docs/partials/05-adding-content/06-skills.md → ...umentation/05-adding-content/06-skills.md b/docs/partials/05-adding-content/06-skills.md → ...umentation/05-adding-content/06-skills.md
diff --git a/...05-adding-content/07-skills-categories.md → ...05-adding-content/07-skills-categories.md b/...05-adding-content/07-skills-categories.md → ...05-adding-content/07-skills-categories.md
diff --git a/...s/05-adding-content/08-timeline-events.md → ...n/05-adding-content/08-timeline-events.md b/...s/05-adding-content/08-timeline-events.md → ...n/05-adding-content/08-timeline-events.md
diff --git a/...s/05-adding-content/09-social-networks.md → ...n/05-adding-content/09-social-networks.md b/...s/05-adding-content/09-social-networks.md → ...n/05-adding-content/09-social-networks.md
diff --git a/docs/partials/06-dependencies.md → docs/pages/documentation/06-dependencies.md b/docs/partials/06-dependencies.md → docs/pages/documentation/06-dependencies.md
diff --git a/docs/partials/07-credits.md → docs/pages/documentation/07-credits.md b/docs/partials/07-credits.md → docs/pages/documentation/07-credits.md
diff --git a/docs/elements.html → docs/pages/elements.html b/docs/elements.html → docs/pages/elements.html
diff --git a/docs/github.md → docs/pages/github.md b/docs/github.md → docs/pages/github.md
diff --git a/index.html → docs/pages/index.md b/index.html → docs/pages/index.md
@@ -1,5 +1,6 @@
 ---
 layout: default
+permalink: /
 ---
 
 {% include landing.html %}
diff --git a/pages/projects.html → docs/pages/projects.html b/pages/projects.html → docs/pages/projects.html
diff --git a/search.json → docs/search.json b/search.json → docs/search.json
diff --git a/docs/assets/Button.png → imgs/Button.png b/docs/assets/Button.png → imgs/Button.png
diff --git a/docs/assets/Logo.png → imgs/Logo.png b/docs/assets/Logo.png → imgs/Logo.png
diff --git a/docs/assets/Preview.gif → imgs/Preview.gif b/docs/assets/Preview.gif → imgs/Preview.gif
diff --git a/docs/assets/Thumbnail.png → imgs/Thumbnail.png b/docs/assets/Thumbnail.png → imgs/Thumbnail.png
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		source "https://rubygems.org"

		gem "portfolyou-jekyll-theme", path: "../"