diff --git a/README.md b/README.md index a8e37bc..62d9e6a 100644 --- a/README.md +++ b/README.md @@ -1,122 +1,10 @@ -# eleventy-base-blog v8 +# nycki.net v2 -A starter repository showing how to build a blog with the [Eleventy](https://www.11ty.dev/) site generator (using the [v2.0 release](https://www.11ty.dev/blog/eleventy-v2/)). +My webbed site! Based on [eleventy-base-blog](https://github.com/11ty/eleventy-base-blog). -## Getting Started +## Building -* [Want a more generic/detailed getting started guide?](https://www.11ty.dev/docs/getting-started/) - -1. Make a directory and navigate to it: - -``` -mkdir my-blog-name -cd my-blog-name -``` - -2. Clone this Repository - -``` -git clone https://github.com/11ty/eleventy-base-blog.git . -``` - -_Optional:_ Review `eleventy.config.js` and `_data/metadata.js` to configure the site’s options and data. - -3. Install dependencies - -``` -npm install -``` - -4. Run Eleventy - -Generate a production-ready build to the `_site` folder: - -``` -npx @11ty/eleventy -``` - -Or build and host on a local development server: - -``` -npx @11ty/eleventy --serve -``` - -Or you can run [debug mode](https://www.11ty.dev/docs/debugging/) to see all the internals. - -## Features - -- Using [Eleventy v2.0](https://www.11ty.dev/blog/eleventy-v2/) with zero-JavaScript output. - - Content is exclusively pre-rendered (this is a static site). - - Can easily [deploy to a subfolder without changing any content](https://www.11ty.dev/docs/plugins/html-base/) - - All URLs are decoupled from the content’s location on the file system. - - Configure templates via the [Eleventy Data Cascade](https://www.11ty.dev/docs/data-cascade/) -- **Performance focused**: four-hundos Lighthouse score out of the box! - - [View the Lighthouse report for the latest build](https://eleventy-base-blog.netlify.app/reports/lighthouse/) courtesy of the [Netlify Lighthouse plugin](https://github.com/netlify/netlify-plugin-lighthouse). - - _0 Cumulative Layout Shift_ - - _0ms Total Blocking Time_ -- Local development live reload provided by [Eleventy Dev Server](https://www.11ty.dev/docs/dev-server/). -- Content-driven [navigation menu](https://www.11ty.dev/docs/plugins/navigation/) -- [Image optimization](https://www.11ty.dev/docs/plugins/image/) via the `{% image %}` shortcode. - - Zero-JavaScript output. - - Support for modern image formats automatically (e.g. AVIF and WebP) - - Prefers `` markup if possible (single image format) but switches automatically to `` for multiple image formats. - - Automated `` syntax markup with `srcset` and optional `sizes` - - Includes `width`/`height` attributes to avoid [content layout shift](https://web.dev/cls/). - - Includes `loading="lazy"` for native lazy loading without JavaScript. - - Includes [`decoding="async"`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/decoding) - - Images can be co-located with blog post files. - - View the [Image plugin source code](https://github.com/11ty/eleventy-base-blog/blob/main/eleventy.config.images.js) -- Per page CSS bundles [via `eleventy-plugin-bundle`](https://github.com/11ty/eleventy-plugin-bundle). -- Built-in [syntax highlighter](https://www.11ty.dev/docs/plugins/syntaxhighlight/) (zero-JavaScript output). -- Blog Posts - - Draft posts: use `draft: true` to mark a blog post as a draft. Drafts are **only** included during `--serve`/`--watch` and are excluded from full builds. View the [Drafts plugin source code](https://github.com/11ty/eleventy-base-blog/blob/main/eleventy.config.drafts.js). - - Automated next/previous links - - Accessible deep links to headings -- Generated Pages - - Home, Archive, and About pages. - - [Feeds for Atom and JSON](https://www.11ty.dev/docs/plugins/rss/) - - `sitemap.xml` - - Zero-maintenance tag pages ([View on the Demo](https://eleventy-base-blog.netlify.app/tags/)) - - Content not found (404) page - -## Demos - -- [Netlify](https://eleventy-base-blog.netlify.app/) -- [Vercel](https://demo-base-blog.11ty.dev/) -- [GitHub Pages](https://11ty.github.io/eleventy-base-blog/) -- [Remix on Glitch](https://glitch.com/~11ty-eleventy-base-blog) -- [Cloudflare Pages](https://eleventy-base-blog-d2a.pages.dev/) - -## Deploy this to your own site - -Deploy this Eleventy site in just a few clicks on these services: - -- [Deploy this to **Netlify**](https://app.netlify.com/start/deploy?repository=https://github.com/11ty/eleventy-base-blog) -- [Deploy this to **Vercel**](https://vercel.com/import/project?template=11ty%2Feleventy-base-blog) -- Look in `.github/workflows/gh-pages.yml.sample` for information on Deploying to **GitHub Pages**. -- [Try it out on **Stackblitz**](https://stackblitz.com/github/11ty/eleventy-base-blog) -- If you run Eleventy locally you can drag your `_site` folder to [`netlify.com/drop`](https://netlify.com/drop) to upload it without using `git`. -- Read more about [Deploying an Eleventy project](https://www.11ty.dev/docs/deployment/) to the web. - -### Implementation Notes - -- `content/about/index.md` is an example of a content page. -- `content/blog/` has the blog posts but really they can live in any directory. They need only the `posts` tag to be included in the blog posts [collection](https://www.11ty.dev/docs/collections/). -- Use the `eleventyNavigation` key (via the [Eleventy Navigation plugin](https://www.11ty.dev/docs/plugins/navigation/)) in your front matter to add a template to the top level site navigation. This is in use on `content/index.njk` and `content/about/index.md`. -- Content can be in _any template format_ (blog posts needn’t exclusively be markdown, for example). Configure your project’s supported templates in `eleventy.config.js` -> `templateFormats`. -- The `public` folder in your input directory will be copied to the output folder (via `addPassthroughCopy` in the `eleventy.config.js` file). This means `./public/css/*` will live at `./_site/css/*` after your build completes. -- Provides two content feeds: - - `content/feed/feed.njk` - - `content/feed/json.njk` -- This project uses three [Eleventy Layouts](https://www.11ty.dev/docs/layouts/): - - `_includes/layouts/base.njk`: the top level HTML structure - - `_includes/layouts/home.njk`: the home page template (wrapped into `base.njk`) - - `_includes/layouts/post.njk`: the blog post template (wrapped into `base.njk`) -- `_includes/postslist.njk` is a Nunjucks include and is a reusable component used to display a list of all the posts. `content/index.njk` has an example of how to use it. - -#### Content Security Policy - -If your site enforces a [Content Security Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP) (as public-facing sites should), you have a few choices (pick one): - -1. In `base.njk`, remove `` and uncomment `` -2. Configure the server with the CSP directive `style-src: 'unsafe-inline'` (less secure). +- install npm +- clone this repo +- `npm install` +- `npm run build`