readcv

readcv

This package contains helper functions for creating your Read.cv site or template.

combineCollections

The combineCollections helper function is provided by default via the readcv library. Use it to combine multiple collections into a single array, sorted chronologically. You will see combineCollections imported by default in Global imports.

import { combineCollections } from 'readcv';

Example

A common use case would be wanting to display your projects and side projects in a single list.

// a simple component that combines projects and side projects
function AllProjects(props) {
	let allProjects = combineCollections(cv.projects, cv.sideProjects);

	return (
		<ul>
			{allProjects.map((project, index) => {
				return (
					<li>{project.title}</li>
				)
			})}
		</ul>
	)
}

RichText

The RichText component is provided by default via the readcv library. Use the RichText component wherever you need to render a string as rich text. You will see RichText imported by default in Global imports.

import { RichText } from 'readcv';

Example

A common example would be the description field of an experience, or the about field on profiles.

// a simple component that displays a user's about section
import { RichText } from 'readcv';

function About(props) {
	return (
		<RichText text={cv.general.about}/>
	)
}