Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mwdelaney/zeropoint

A modern, opinionated, bare-bones Jamstack starter using Eleventy to get "up to zero" on a project quickly and easily. https://getzeropoint.com
https://github.com/mwdelaney/zeropoint

11ty 11ty-starter eleventy jamstack sass static-site-generator template

Last synced: 1 day ago
JSON representation

A modern, opinionated, bare-bones Jamstack starter using Eleventy to get "up to zero" on a project quickly and easily. https://getzeropoint.com

Awesome Lists containing this project

README

        

# ZeroPoint

## Start building your website

Create and edit your site **right from this readme file!**.

🪐 Or edit your entire site in a web-based editor by [clicking here](https://github.dev/MWDelaney/ZeroPoint/).

📝 Creating and editing pages

## Creating and editing pages and content

### Pages

Create your site's main content! Pages can be written in HTML or [Markdown](https://www.markdownguide.org/basic-syntax/)!

* [Edit the homepage](https://github.com/MWDelaney/ZeroPoint/edit/main/src/content/pages/index.md)
* [Create a new page](https://github.com/MWDelaney/ZeroPoint/new/main/?filename=/src/content/pages/&value=---%0Atitle%3A%20Enter%20page%20title%20here%0A---)

🎨 Look and Feel

## Look and Feel

### Navigation

Your site's navigation is how your users will get around! Edit the site's navigation menu in [JSON format](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Objects/JSON)!

* [Edit the navigation](https://github.com/MWDelaney/ZeroPoint/edit/main/src/data/navigation.json)

### Styles

Colors, spacing, and fonts, oh my! You can edit your branding and styles here using CSS, SCSS, and CSS variables!

* [Edit your branding](https://github.com/MWDelaney/zeropoint/edit/main/src/assets/styles/_branding.scss)
* [Edit your overall styles](https://github.com/MWDelaney/zeropoint/edit/main/src/assets/styles/styles.scss)

Learning CSS can be daunting but there are a ton of useful resources on the web. Check out [SmolCSS](https://smolcss.dev) to get started!

### Javascript

**Optional!** Add javascript functionality to your site

* [Add Javascript](https://github.com/MWDelaney/zeropoint/edit/main/src/assets/scripts/main.js)

🚀 Deploy ZeroPoint

## Deploy ZeroPoint

Once you set up deployment, any time you commit to your repository's `main` branch, GitHub will build and deploy your site.

Deploy to GitHub Pages

### Setup:

1. [Enable GitHub Pages](https://github.com/MWDelaney/ZeroPoint/settings/pages) in your repository settings, choose "GitHub Actions" as the source.
2. [Allow "Read and write permissions" for GitHub Workflows](https://github.com/MWDelaney/ZeroPoint/settings/actions) in your repository settings for the GitHub Actions workflow to run.

Deploy to Netlify

### Setup:

[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/MWDelaney/ZeroPoint/)

---

## Get to Know ZeroPoint

Ready to go deeper? Here's how ZeroPoint is laid out:

```sh
example.com # → Root of your project
├── src/ # → Source directory
│ ├── assets/ # → Site assets
│ │ ├── fonts/
│ │ ├── images/
│ │ ├── scripts/
│ │ ├── styles/
│ │ ├── views/
│ │ │ └── layouts/
│ │ │ └── partials/
│ │ └── assets.json # → Shared attributes for files in the assets directory
│ ├── config/ # → Eleventy configuration
│ │ ├── build.js # → Javascript and CSS build and bundler configuration
│ │ ├── collections.js # → Add and configure collections (https://www.11ty.dev/docs/collections/)
│ │ ├── filters.js # → Add and configure filters (https://www.11ty.dev/docs/filters/)
│ │ ├── passthroughs.js # → Add and configure passthroughs (https://www.11ty.dev/docs/copy/)
│ │ ├── plugins.js # → Add and configure plugins (https://www.11ty.dev/docs/plugins/)
│ │ ├── shortcodes.js # → Add and configure shortcodes (https://www.11ty.dev/docs/shortcodes/)
│ │ ├── templateLanguages.js # → Configure custom template languages (https://www.11ty.dev/docs/languages/custom/)
│ │ ├── watchtargets.js # → Add and configure watch targets (https://www.11ty.dev/docs/watch-serve/)
│ │ └── config.json # → Shared attributes for files in the config directory
│ ├── content # → A nice, organized, recommended place for all site content
│ │ └── pages # → Add "pages" collection items here
│ └── data # → Customize site data (https://www.11ty.dev/docs/data/)
│ ├── navigation.json # → Site navigation configuration
│ └── site.json # → Site branding configuration
├── .eleventy.js # → Core Eleventy config file
├── netlify.toml # → Netlify deployment and plugin configuration (optional)
├── README.ZeroPoint.md # → Template repository readme
└── README.md
```

## Eleventy Configuration

Eleventy configuration is abstracted from the typical `.eleventy.js` file and moved to `/src/config/` for easy organization and configuration of collections, filters, passthroughs, etc.

## Install project dependencies

```bash
npm i
```

## Run the project locally

```bash
npm run dev
```

## Build for staging

(The same as production except every page is flagged `noindex`)

```bash
npm run staging
```

## Build for production

```bash
npm run production
```