harmolipi / 11ty-portfolio

Fernfolio

The super simple portfolio template built with Eleventy and Netlify CMS

🖥  Demo

🤔 What is this?

An Eleventy theme designed to simplify the process of deploying a beautiful portfolio and blog. Launch your site in minutes!

Based on the eleventy-netlify-boilerplate, but modified to perfectly fit the needs of a modern technical porfolio.

✨ Features

• Built in support for Netlify CMS with editor previews
• Customizable blog and project pages with tag support
• Working contact form powered by Netlify Forms
• Super fast page render and high lighthouse scores
• Uses Markdown for content files and Nunjucks for layouts
• 100% Javascript framework free
• Continuous Deployment workflow via Netlify
• Base styles powered by Sakura classless css framework
• Vanilla css for custom styles (keep it simple)

🚀 Quick Start

1. Click the "Deploy to Netlify" button above

This will clone this repo to your github account and will deploy a copy of the demo website to your Netlify account (you can create an account during this process if you don't have one)

2. Setup authentication

After deploying this project, Netlify Identity will add you as a CMS user and will email you an invite. Hit the "Accept the invite" link and this should take you to the deployed site. From there, you can add your password to finish user setup.

3. Edit some content

Now that you are added as a CMS user, add /admin to the end of your site url, and log in using your new credentials. You should now see the content editor interface. Now you can start editing content! Any changes to your new repo will auto-deploy a new version to netflify. Cool huh?

4. Setup local environment

• Clone the repo locally git clone https://github.com/TylerMRoderick/fernfolio-11ty-template.git
• Navigate to root folder cd your-site
• Install the goods npm install
• Run it npm start
• You should now be able to see everything running on localhost:8080
• Add some changes (view theme customizations for some options)
• Push your changes to github and an auto-deploy should be triggered

💻 Development Scripts

npm start

Run 11ty with hot reload at localhost:8080

npm run build

Generate minified production build

Use this as the "Publish command" if needed by hosting such as Netlify.

Checkout the Eleventy Command Line Usage docs for more options

🎩 Common issues

If you change the repo that was created at deploy time from public to private, you'll need to regenerate your token, as the token generated using the deploy to Netlify button can only access public repositories. To regenerate your token, head to "Settings" in your Netlify site dashboard, go to the "Identity" section, then scroll to "Services" where you'll see an "Edit settings" button. Click that and you'll see a text link to "Generate access token in GitHub".

If you need any help with setting up Netlify CMS, you can reach out to the Netlify team in the Netlify CMS Gitter.

Bug reports, feature requests, etc

This is an ongoing project and I welcome contributions and suggestions! Feel free to submit a PR or issue.