From 56e7fd3e1729233b943bc935bdca0b0d389bb693 Mon Sep 17 00:00:00 2001 From: Derek <42170307+2-REC@users.noreply.github.com> Date: Sat, 17 Nov 2018 14:32:43 +0700 Subject: More detailed "Projects" section. --- README.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 06f92a3..1a991fb 100644 --- a/README.md +++ b/README.md @@ -155,16 +155,25 @@ All the parameters except "text" are optional - if not defined, it will not be a ### PROJECTS: Create a portfolio (or more) -!!!! TODO !!!! -... -=> List of companies/categories, linking to individual pages with projects listing. -- Based on CREATIVE theme, "Portfolio", but with links to other pages. -- Content: "config.toml" & corresponding "_index.md" file (from section name). +This section serves as a showcase for a "Portfolio" of projects. +It is composed of a grid representing a set of subsections, each grouping "Projects" into "Categories". +It is based on the "Portfolio" section of the CREATIVE theme, but with an additional level of categories above the projects level. Also, instead of opening a pop-up window when selecting an element in the grid, it opens a new page displaying the contained projects. + +A portfolio section "Projects" is defined in the Homepage via the "config.toml" configuration file. Additionaly to the entry specified in the file, a directory with the same name must exist at the top level of the website file structure, containing its associated "_index.md" file. ![Section Screenshot](https://github.com/2-REC/hugo-myportfolio-theme/blob/master/images/section.png) + +A section is composed of "subsections" (typically categories, companies, technologies, etc.) grouping projects together. A subsection is defined by a subdirectory in a section directory also containing its associated "_index.md" file. Each subsection will be automatically added in the section menu. +Sectikns and subsections correspond to list pages in the Hugo jargon. ![List Screenshot](https://github.com/2-REC/hugo-myportfolio-theme/blob/master/images/list.png) + +Subsections are in turn composed of "projects", each one defined by a post file or by a directory in case it is a bundle - containing more than a file, and generally images (the directiry must contain a "index.md" file in order to be considered as a post entry). ![Project Screenshot](https://github.com/2-REC/hugo-myportfolio-theme/blob/master/images/project.png) +For each post ("project"), "tags" and "categories" should be specified, in order to allow easy keywords filtering (the taxonomy pages resulting in the filtering results will automatically be generated by Hugo). + +There can be more than one main projects sections. + ### CONTACT: Add contact information -- cgit v1.2.3