https://github.com/conedevelopment/root-site-eleventy
The documentation of Root.
https://github.com/conedevelopment/root-site-eleventy
11ty laravel
Last synced: 7 months ago
JSON representation
The documentation of Root.
- Host: GitHub
- URL: https://github.com/conedevelopment/root-site-eleventy
- Owner: conedevelopment
- Created: 2024-12-14T18:33:32.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-02-01T09:56:03.000Z (about 1 year ago)
- Last Synced: 2025-02-10T01:25:58.205Z (about 1 year ago)
- Topics: 11ty, laravel
- Language: CSS
- Homepage: https://root.conedevelopment.com
- Size: 63.3 MB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
**Root uses [11ty](https://www.11ty.dev/) for its documentation (v2).**
[](https://app.netlify.com/sites/conedevelopment-root/deploys)
## Get Up and Running
We use `eleventy --serve` and compile Sass with sass-cli with npm scripts.
1. **Clone the repository**
2. **Install the dependencies**
In the `package.json` file, you will find all of the dependencies (and scripts) to install them using the following command:
```shell
npm install
```
3. **Run the development mode**
To run the development mode, use the `npm run start`. This script will also watch for changes.
```shell
npm run start
```
4. **Run the production mode**
Before you go live, you should use the production script to compress the Sass files.
```shell
npm run build
```
## SCSS
The project compiles the SCSS files from the `./src/scss` folder into the `./src/css` folder. The project includes [Spruce CSS](https://sprucecss.com/), which gives the styling with some [Spruce UI](https://sprucecss.com/ui/getting-started/introduction/) components.
## Other Scripts
- **sass:lint/sass:lint:fix** You can lint your SCSS files with [Stylelint](https://stylelint.io/) and [stylelint-config-sass-guidelines](https://github.com/bjankord/stylelint-config-sass-guidelines) preset with the `npm run sass:lint` command. Use the `npm run sass:lint:fix` command if you want automatic fixes.