From 6b01c7a30eb0245376c55226cc3d7ad63f88d45e Mon Sep 17 00:00:00 2001 From: Youssef Raafat Date: Sat, 25 Jan 2020 13:52:09 +0200 Subject: [PATCH] Change Directory Structure --- docs/_config.yml | 2 +- docs/{pages => documentation}/docs.md | 6 +++--- docs/{pages => documentation}/elements.html | 0 docs/{pages => documentation}/github.md | 0 .../partials}/00-common/01-repo-buttons.html | 0 .../partials}/00-common/02-description.md | 0 .../partials}/00-common/03-toc.md | 2 ++ .../partials}/01-features.md | 0 .../partials}/02-installation.md | 0 .../02-installation/01-github-pages.md | 0 .../partials}/02-installation/02-fork.md | 0 .../partials/03-customization.md} | 0 .../partials/04-adding-content.md} | 0 .../04-adding-content}/01-local-projects.md | 0 .../04-adding-content}/02-remote-projects.md | 0 .../partials/04-adding-content}/03-posts.md | 0 .../partials/04-adding-content}/04-pages.md | 0 .../04-adding-content}/05-external-content.md | 0 .../partials/04-adding-content}/06-skills.md | 0 .../07-skills-categories.md | 0 .../04-adding-content}/08-timeline-events.md | 0 .../04-adding-content}/09-social-networks.md | 0 .../partials/05-dependencies.md} | 0 .../partials/06-credits.md} | 0 docs/pages/documentation/03-sections.md | 20 ------------------- docs/{ => pages}/search.json | 0 26 files changed, 6 insertions(+), 24 deletions(-) rename docs/{pages => documentation}/docs.md (72%) rename docs/{pages => documentation}/elements.html (100%) rename docs/{pages => documentation}/github.md (100%) rename docs/{pages/documentation => documentation/partials}/00-common/01-repo-buttons.html (100%) rename docs/{pages/documentation => documentation/partials}/00-common/02-description.md (100%) rename docs/{pages/documentation => documentation/partials}/00-common/03-toc.md (88%) rename docs/{pages/documentation => documentation/partials}/01-features.md (100%) rename docs/{pages/documentation => documentation/partials}/02-installation.md (100%) rename docs/{pages/documentation => documentation/partials}/02-installation/01-github-pages.md (100%) rename docs/{pages/documentation => documentation/partials}/02-installation/02-fork.md (100%) rename docs/{pages/documentation/04-customization.md => documentation/partials/03-customization.md} (100%) rename docs/{pages/documentation/05-adding-content.md => documentation/partials/04-adding-content.md} (100%) rename docs/{pages/documentation/05-adding-content => documentation/partials/04-adding-content}/01-local-projects.md (100%) rename docs/{pages/documentation/05-adding-content => documentation/partials/04-adding-content}/02-remote-projects.md (100%) rename docs/{pages/documentation/05-adding-content => documentation/partials/04-adding-content}/03-posts.md (100%) rename docs/{pages/documentation/05-adding-content => documentation/partials/04-adding-content}/04-pages.md (100%) rename docs/{pages/documentation/05-adding-content => documentation/partials/04-adding-content}/05-external-content.md (100%) rename docs/{pages/documentation/05-adding-content => documentation/partials/04-adding-content}/06-skills.md (100%) rename docs/{pages/documentation/05-adding-content => documentation/partials/04-adding-content}/07-skills-categories.md (100%) rename docs/{pages/documentation/05-adding-content => documentation/partials/04-adding-content}/08-timeline-events.md (100%) rename docs/{pages/documentation/05-adding-content => documentation/partials/04-adding-content}/09-social-networks.md (100%) rename docs/{pages/documentation/06-dependencies.md => documentation/partials/05-dependencies.md} (100%) rename docs/{pages/documentation/07-credits.md => documentation/partials/06-credits.md} (100%) delete mode 100644 docs/pages/documentation/03-sections.md rename docs/{ => pages}/search.json (100%) diff --git a/docs/_config.yml b/docs/_config.yml index 206daf81d..560bd00b6 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -21,7 +21,7 @@ nav_exclude: # Pages with the following paths will be exc - pages/tags.html - pages/404.html - pages/index.md - - pages/documentation/** + - documentation/partials/** ### Author Info ### diff --git a/docs/pages/docs.md b/docs/documentation/docs.md similarity index 72% rename from docs/pages/docs.md rename to docs/documentation/docs.md index e7e5a1a06..94387998d 100644 --- a/docs/pages/docs.md +++ b/docs/documentation/docs.md @@ -8,11 +8,11 @@ weight: 5 # About portfolYOU {{ site.github.latest_release.tag_name }} {:.no_toc} -{%- assign documentation_dir = "documentation" -%} -{%- assign docs = site.static_files | where_exp: "file", "file.path contains documentation_dir" -%} +{%- assign partials_dir = "partials" -%} +{%- assign docs = site.static_files | where_exp: "file", "file.path contains partials_dir" -%} {% for doc in docs %} -{% assign parent_dir = doc.path | split: documentation_dir | first %} +{% assign parent_dir = doc.path | split: partials_dir | first %} {% assign relative_path = doc.path | remove: parent_dir %} {% include_relative {{ relative_path }} %} {% endfor %} diff --git a/docs/pages/elements.html b/docs/documentation/elements.html similarity index 100% rename from docs/pages/elements.html rename to docs/documentation/elements.html diff --git a/docs/pages/github.md b/docs/documentation/github.md similarity index 100% rename from docs/pages/github.md rename to docs/documentation/github.md diff --git a/docs/pages/documentation/00-common/01-repo-buttons.html b/docs/documentation/partials/00-common/01-repo-buttons.html similarity index 100% rename from docs/pages/documentation/00-common/01-repo-buttons.html rename to docs/documentation/partials/00-common/01-repo-buttons.html diff --git a/docs/pages/documentation/00-common/02-description.md b/docs/documentation/partials/00-common/02-description.md similarity index 100% rename from docs/pages/documentation/00-common/02-description.md rename to docs/documentation/partials/00-common/02-description.md diff --git a/docs/pages/documentation/00-common/03-toc.md b/docs/documentation/partials/00-common/03-toc.md similarity index 88% rename from docs/pages/documentation/00-common/03-toc.md rename to docs/documentation/partials/00-common/03-toc.md index f86e7d02d..24df65b2f 100644 --- a/docs/pages/documentation/00-common/03-toc.md +++ b/docs/documentation/partials/00-common/03-toc.md @@ -1,2 +1,4 @@ - Automated Table of Contents {:toc} + +*** diff --git a/docs/pages/documentation/01-features.md b/docs/documentation/partials/01-features.md similarity index 100% rename from docs/pages/documentation/01-features.md rename to docs/documentation/partials/01-features.md diff --git a/docs/pages/documentation/02-installation.md b/docs/documentation/partials/02-installation.md similarity index 100% rename from docs/pages/documentation/02-installation.md rename to docs/documentation/partials/02-installation.md diff --git a/docs/pages/documentation/02-installation/01-github-pages.md b/docs/documentation/partials/02-installation/01-github-pages.md similarity index 100% rename from docs/pages/documentation/02-installation/01-github-pages.md rename to docs/documentation/partials/02-installation/01-github-pages.md diff --git a/docs/pages/documentation/02-installation/02-fork.md b/docs/documentation/partials/02-installation/02-fork.md similarity index 100% rename from docs/pages/documentation/02-installation/02-fork.md rename to docs/documentation/partials/02-installation/02-fork.md diff --git a/docs/pages/documentation/04-customization.md b/docs/documentation/partials/03-customization.md similarity index 100% rename from docs/pages/documentation/04-customization.md rename to docs/documentation/partials/03-customization.md diff --git a/docs/pages/documentation/05-adding-content.md b/docs/documentation/partials/04-adding-content.md similarity index 100% rename from docs/pages/documentation/05-adding-content.md rename to docs/documentation/partials/04-adding-content.md diff --git a/docs/pages/documentation/05-adding-content/01-local-projects.md b/docs/documentation/partials/04-adding-content/01-local-projects.md similarity index 100% rename from docs/pages/documentation/05-adding-content/01-local-projects.md rename to docs/documentation/partials/04-adding-content/01-local-projects.md diff --git a/docs/pages/documentation/05-adding-content/02-remote-projects.md b/docs/documentation/partials/04-adding-content/02-remote-projects.md similarity index 100% rename from docs/pages/documentation/05-adding-content/02-remote-projects.md rename to docs/documentation/partials/04-adding-content/02-remote-projects.md diff --git a/docs/pages/documentation/05-adding-content/03-posts.md b/docs/documentation/partials/04-adding-content/03-posts.md similarity index 100% rename from docs/pages/documentation/05-adding-content/03-posts.md rename to docs/documentation/partials/04-adding-content/03-posts.md diff --git a/docs/pages/documentation/05-adding-content/04-pages.md b/docs/documentation/partials/04-adding-content/04-pages.md similarity index 100% rename from docs/pages/documentation/05-adding-content/04-pages.md rename to docs/documentation/partials/04-adding-content/04-pages.md diff --git a/docs/pages/documentation/05-adding-content/05-external-content.md b/docs/documentation/partials/04-adding-content/05-external-content.md similarity index 100% rename from docs/pages/documentation/05-adding-content/05-external-content.md rename to docs/documentation/partials/04-adding-content/05-external-content.md diff --git a/docs/pages/documentation/05-adding-content/06-skills.md b/docs/documentation/partials/04-adding-content/06-skills.md similarity index 100% rename from docs/pages/documentation/05-adding-content/06-skills.md rename to docs/documentation/partials/04-adding-content/06-skills.md diff --git a/docs/pages/documentation/05-adding-content/07-skills-categories.md b/docs/documentation/partials/04-adding-content/07-skills-categories.md similarity index 100% rename from docs/pages/documentation/05-adding-content/07-skills-categories.md rename to docs/documentation/partials/04-adding-content/07-skills-categories.md diff --git a/docs/pages/documentation/05-adding-content/08-timeline-events.md b/docs/documentation/partials/04-adding-content/08-timeline-events.md similarity index 100% rename from docs/pages/documentation/05-adding-content/08-timeline-events.md rename to docs/documentation/partials/04-adding-content/08-timeline-events.md diff --git a/docs/pages/documentation/05-adding-content/09-social-networks.md b/docs/documentation/partials/04-adding-content/09-social-networks.md similarity index 100% rename from docs/pages/documentation/05-adding-content/09-social-networks.md rename to docs/documentation/partials/04-adding-content/09-social-networks.md diff --git a/docs/pages/documentation/06-dependencies.md b/docs/documentation/partials/05-dependencies.md similarity index 100% rename from docs/pages/documentation/06-dependencies.md rename to docs/documentation/partials/05-dependencies.md diff --git a/docs/pages/documentation/07-credits.md b/docs/documentation/partials/06-credits.md similarity index 100% rename from docs/pages/documentation/07-credits.md rename to docs/documentation/partials/06-credits.md diff --git a/docs/pages/documentation/03-sections.md b/docs/pages/documentation/03-sections.md deleted file mode 100644 index b3d0d3804..000000000 --- a/docs/pages/documentation/03-sections.md +++ /dev/null @@ -1,20 +0,0 @@ -## Sections - -portfolYOU's sections are **independent**, you can remove any section upon your needs. Here's a list of the files and folders needed by each section: - -| Projects | Blog | About | -| :--------- | :--------- | :--------- | -| pages/projects.html | blog/ | pages/about.md | -| _includes/projects/ | _includes/blog/ | _includes/about/ | -| _sass/projects.scss ¹ | _sass/_blog.scss ¹ | _sass/_skills.scss ¹ | -| assets/js/card-animation.js ² | _layouts/post.html | _sass/_timeline.scss ¹ | -| _projects/ ³ | _posts/ ⁴ | _data/ ⁵ | - - - If you are deleting any section, please consider the following:
- ¹ remove reference from _sass/portfolYOU.scss
- ² remove reference from _includes/scripts.html
- ³ remove collections and defaults from _config.yml
- ⁴ remove permalink and pagination from _config.yml
- ⁵ except _data/social-media.yml - diff --git a/docs/search.json b/docs/pages/search.json similarity index 100% rename from docs/search.json rename to docs/pages/search.json