Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
create-slinkity
Advanced tools
create-slinkity - npm Package Compare versions
Comparing version 1.1.1-canary.2 to 1.1.1-canary.3
| { | ||
| "name": "create-slinkity", | ||
| "version": "1.1.1-canary.2", | ||
| "version": "1.1.1-canary.3", | ||
| "description": "The splendid starter to scaffold your Slinkity site.", | ||
@@ -5,0 +5,0 @@ "main": "cli.js", |
@@ -7,2 +7,3 @@ { | ||
| "scripts": { | ||
| "dev": "slinkity --serve --incremental", | ||
| "start": "slinkity --serve --incremental", | ||
@@ -13,5 +14,5 @@ "build": "slinkity" | ||
| "devDependencies": { | ||
| "@11ty/eleventy": "^1.0.0-beta.8", | ||
| "@11ty/eleventy": "^1.0.0", | ||
| "slinkity": "^0.6.1-canary.0" | ||
| } | ||
| } |
|  | ||
| <h1 align="center">Welcome to Slinkity starter project 👋</h1> | ||
| <p> | ||
| <img alt="Version" src="https://img.shields.io/badge/version-1.0.0-blue.svg?cacheSeconds=2592000" /> | ||
| <a href="https://slinkity.dev/docs/" target="_blank"> | ||
| <img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" /> | ||
| </a> | ||
| <a href="https://github.com/slinkity/slinkity-starter/graphs/commit-activity" target="_blank"> | ||
| <img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" /> | ||
| </a> | ||
| <a href="https://github.com/slinkity/slinkity-starter/blob/master/LICENSE" target="_blank"> | ||
| <img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg" /> | ||
| </a> | ||
| <a href="https://twitter.com/slinkitydotdev" target="_blank"> | ||
| <img alt="Twitter: slinkitydotdev" src="https://img.shields.io/twitter/follow/slinkitydotdev.svg?style=social" /> | ||
| </a> | ||
| </p> | ||
| # Welcome to your splendid Slinkity starter 👋 | ||
| <h3 align="center">The all-in-one template for building your first Slinkity project</h3> | ||
| This demos [Slinkity's](https://slinkity.dev) core functionality while staying as lean as possible, making it the perfect launchpad for new projects 🚀 | ||
| [Slinkity](https://slinkity.dev) is a framework that uses Vite to bring dynamic, client side interactions to your static 11ty sites. Slinkity lets you swap out existing templates like `.html` or `.liquid` for component templates like `.jsx`. What's more, it allows you to insert components into pages using shortcodes, like this one: `{% react './path/to/Component.jsx' %}`. And since you can opt-in to hydrating components clientside, dynamic state variables can work in both development and production. | ||
| It includes: | ||
| With these capabilities, we aim to unify two competing camps in the web development community: | ||
| * **Lean, JavaScript-free static site generators** driven by data and templating languages like Jekyll and Hugo. | ||
| * **Dynamic, JavaScript-heavy web apps** powered by data and component frameworks like NextJS and NuxtJS. | ||
| - component(s) embedded into a static `.md` template → [more on component shortcodes here](https://slinkity.dev/docs/component-shortcodes/) | ||
| - route(s) built using a component framework as a templating language → [more on component pages here](https://slinkity.dev/docs/component-pages-layouts/) | ||
| - a `netlify.toml` configured to deploy in a flash → [more on deployment here](https://slinkity.dev/docs/deployment/) | ||
| - an eleventy config with a few recommended defaults → [more on config here](https://slinkity.dev/docs/config/#recommended-config-options) | ||
| ## Install dependencies and start development server | ||
| `yarn start` runs `slinkity --serve` to start [a Vite server](https://vitejs.dev/guide/#index-html-and-project-root) pointed at your 11ty build. The `--incremental` flag can be used for faster builds during development. | ||
| ## Install dependencies and start the dev server | ||
| ```bash | ||
| yarn | ||
| yarn start | ||
| npm i | ||
| npm run dev | ||
| ``` | ||
| Open [localhost:8080](http://localhost:8080/) to view your site. Vite's development server enables processing a range of resources including SASS and React. | ||
| `npm run dev` runs `slinkity --serve --incremental` to start [a Vite server](https://vitejs.dev/guide/#index-html-and-project-root) pointed at your 11ty build. The `--incremental` flag prevents flashes of unstyled content during development. | ||
| Open [localhost:8080](http://localhost:8080/) to view your site. Vite's development server enables processing a range of resources including SCSS and your favorite component framework. | ||
| ## Build for production | ||
| Run the `slinkity` to process your files in a 2 step process: | ||
| ```bash | ||
| npm run build | ||
| ``` | ||
| This runs the `slinkity` command to kick off a 2 step build process: | ||
| - Use 11ty to build your routes and copy over static assets | ||
| - Use Vite to bundle, minify, and optimize your styles and JS resources | ||
| ```bash | ||
| yarn build | ||
| ``` | ||
| Your new site will appear in the `_site` folder, or [wherever you tell 11ty to build your site](https://www.11ty.dev/docs/config/#output-directory). | ||
| ## `.eleventy.js` | ||
| ## Config | ||
| Slinkity relies on 11ty's [latest 1.0 beta build](https://www.npmjs.com/package/@11ty/eleventy/v/beta) to work properly. Our `.eleventy.js` file includes a few niceties we'd recommend for any Slinkity project, including: | ||
| Our `.eleventy.js` file includes a few niceties we'd recommend for any Slinkity project, including: | ||
@@ -65,3 +52,3 @@ - Setting an input directory | ||
| - `serve` starts the [11ty dev server in `--watch` mode](https://www.11ty.dev/docs/usage/#re-run-eleventy-when-you-save) to listen for file changes. | ||
| - `port` is passed to Slinkity's independent Vite server instead of 11ty's Browsersync server. | ||
| - `port` is passed to Slinkity's independent server instead of 11ty's Browsersync server. | ||
@@ -74,29 +61,8 @@ The CLI checks for Eleventy configs and will look for any custom directories returned, such as input or output. If found, those are passed off to the Vite server so it can look in the right place. | ||
| ## Authors | ||
| 👤 **Ben Holmes** | ||
| * Website: https://bholmes.dev | ||
| * Twitter: [@bholmesdev](https://twitter.com/bholmesdev) | ||
| * Github: [@Holben888](https://github.com/Holben888) | ||
| 👤 **Anthony Campolo** | ||
| * Twitter: [@ajcwebdev](https://twitter.com/ajcwebdev) | ||
| * Github: [@ajcwebdev](https://github.com/ajcwebdev) | ||
| ## 🤝 Contributing | ||
| Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/slinkity/slinkity-starter/issues). | ||
| Slinkity contributions, issues and feature requests are welcome! Feel free to check the [issues page](https://github.com/slinkity/slinkity-starter/issues). | ||
| ## Show your support | ||
| Give a ⭐️ if this project helped you! | ||
| ## 📝 License | ||
| Copyright © 2021 [Ben Holmes](https://github.com/Holben888). This project is [MIT](https://github.com/slinkity/slinkity-starter/blob/master/LICENSE) licensed. | ||
| *** | ||
| _This README was generated with ❤️ by Ben with [readme-md-generator](https://github.com/kefranabg/readme-md-generator) and then heavily edited by Anthony._ | ||
| _This README was generated with ❤️ by Ben with [readme-md-generator](https://github.com/kefranabg/readme-md-generator) (and then heavily edited by Anthony)._ |
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by23.23%
907344
Worsened metrics
- Number of lines in readme file
- decreased by-33.66%
67
No dependency changes