Typedfolio is a project that helps structure the content behind a portfolio website so that it can be presented using a compatible visualisation template. Typedfolio is a specification of extensible data schemas and customisable visualisation templates. The data schemas are generalised content models for common websites, such as portfolios of researchers, developers, designers and so on. The visualisation templates help display the portfolio content, which is conformant with the data schemas, in desired visual output and interaction formats, such as website front-ends.
Is Typedfolio simply a specification? No!
Reference implementations will be provided as listed below.
Warning
The following are forward-looking statements as of January 2024.
- Schema: data model (See https://github.com/typedfolio/schemas-sanity) for the Sanity content management system. Template: the Next.js framework.
- Schema: Python Pydantic models without any content management system. API implementation in FastAPI. Template: Python Jinja.
Typedfolio may not be suitable when:
- the content of the website and its desired functionality are too complex to be generalised using content models, and
- the website or another user interface format is too simple (e.g., this README file and its visualisation as rendered Markdown) to need a content model.
Explain the concept of Typedfolio with one or more diagrams.
Where did this project begin, where is it at and where is it going?