data model

main site

The main site is intended to be a portfolio page. with a impactfull landing page as the site main index, a project index and project data showcase

project definition

content/projects/[project_dir] to create a project
use md|mdx files to define the project in its respective project dir
metadata is defined in the frontmatter of the md|x file, using yaml sintaxis

project main file

[projects]/description.(md|mdx)
description is an esential file used by the page generator to discover pages this file is used to define the project Title, description and images that the site will show, metadata:
#todo: quiza un componente que muestre sobre una imagen el elemento del dom correspondiente al elemento de la lista?

• title:
  this title will be used as the card title in the projects page index

• type:
  project type, used to organize the project in its correspondent section, values for now can be: library, project, component

• index:
  the index in which the project will be shown in its respective section

• banner:
  the image that will be used in the project card

• repo:
  access to the source code of the project

• langs:
  langs and bytes of each, used in the card to showcase the project type

• components:
  pointer to other projects that this project use/depends on

project documentation file(s)

[projects]/[content_file].(md|mdx)
content_file is the content of the project that will be used to show in the project respective page you can use as many content_files as you want, each one will be used en the project’s main page and indexed in the file navigator metadata:

• title:
  This is the title that will be used in the file navigator to index

• index:
  order of which the file will be appear in the file navigator

• slug:
  url in which the file will be available in the site