README.md

Netlify Developer Portfolio Starter (auto-annotated)

This is a full-fledged portfolio website built with Next.js, Tailwind CSS, visual editor and the Git Content Source.

The codebase showcases how to apply annotations at scale, meaning: how to make much of your components highlightable in the visual editor through data attributes without manually adding code throughout the codebase.

This is achieved by:

1. Adding an annotation property to the content objects at they're loaded (see src/utils/content.ts)
2. When rendering the page, each content sub-object is dynamically matched to the appropriate component. At this point, wrap each component with an annotation, based on the abovementioned content property. See src/components/components-registry.tsx.

⚡ Demo: auto-annotated-portfolio.netlify.app

Deploying to Netlify

If you click "Deploy to Netlify" button, it will create a new repo for you that looks exactly like this one, and sets that repo up immediately for deployment on Netlify.

Getting Started

The typical development process is to begin by working locally. Clone this repository, then run npm install in its root directory.

Run the Next.js development server:

cd auto-annotated-portfolio
npm run dev

Install the Netlify visual editor CLI. Then open a new terminal window in the same project directory and run the Netlify visual editor dev server:

npm install -g @stackbit/cli
stackbit dev

This outputs your own Netlify visual editor URL. Open this, register or sign in, and you will be directed to Netlify's visual editor for your new project.

Next Steps

Here are a few suggestions on what to do next if you're new to Netlify Visual Editor:

• Learn how Netlify Visual Editor works
• Check Netlify visual editor reference documentation

Support

If you get stuck along the way, get help in our support forums.