emilyyleung / eleventy-bragdoc

Eleventy theme inspired by Julia Evan's Brag Document. Original Bragdocs design by Jonny Burch and the team at Progression.app

Home Page:https://emilyyleung.github.io/eleventy-bragdoc

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

eleventy-bragdoc

Check out the demo

A starter site for building your own brag document, using 11ty (demo). Inspired by Julia Evans, and Bragdocs design by Jonny Burch and the team at Progression.app.

Built using:

Themes

So far, I've included 2 themes (light and dark). The colours have been assigned at the beginning of src/css/styles.css and can be easily changed.

Light Theme

light-theme

Dark Theme

dark-theme

You can switch between them by changing the data-theme variable from default light to dark in src/includes/layouts/base.njk

Features

  • Eleventy for static site generation
  • Nunjucks for templating
  • Static tags
  • SEO base template can be found in src/data/site.json
  • Frontmatter property: Icon use Segoe UI Emoji inspired by Notion style
  • Frontmatter property: public can be set to True or False depending on whether you would like to make it visible to your timeline
  • Order is sorted with latest entry at the top

Dependencies

# Install dependencies
npm install

Available Scripts

Development

# Runs the app in local development mode
npm start

Open http://localhost:8080/ to view in the browser.

Production

# Builds a static copy of your site to the `public/` folder
npm run-script build

Publish onto Github Pages

Follow this link to create your own Github Pages

# Push the content on Github Pages
npm run deploy

Credits

License

This project is open source and available under the MIT License

About

Eleventy theme inspired by Julia Evan's Brag Document. Original Bragdocs design by Jonny Burch and the team at Progression.app

https://emilyyleung.github.io/eleventy-bragdoc

License:MIT License


Languages

Language:CSS 46.8%Language:Nunjucks 41.0%Language:JavaScript 9.2%Language:HTML 3.0%