https://github.com/spandigital/presidium-styling-base

The global default styling for Presidium themes.
https://github.com/spandigital/presidium-styling-base

hugo presidium styling themes

Last synced: 4 days ago
JSON representation

The global default styling for Presidium themes.

• Host: GitHub
• URL: https://github.com/spandigital/presidium-styling-base
• Owner: SPANDigital
• License: mit
• Created: 2024-09-05T07:55:10.000Z (5 months ago)
• Default Branch: develop
• Last Pushed: 2024-12-18T11:30:37.000Z (about 1 month ago)
• Last Synced: 2024-12-18T12:20:40.856Z (about 1 month ago)
• Topics: hugo, presidium, styling, themes
• Language: SCSS
• Homepage: https://presidium.spandigital.net/
• Size: 2 MB
• Stars: 0
• Watchers: 7
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# presidium-styling-base

## Linting and Pre-Commit Hook Setup

This project uses `Stylelint`, `Prettier`, and `Husky` to ensure consistent SCSS formatting and linting. A pre-commit hook is configured to automatically run linting tasks before commits.

### Prerequisites

- Ensure **Node.js** and **Yarn** are installed.

- Clone the repository to your local machine.

### Installation

1. Install dependencies:

  ```bash

  yarn install

2. Set up Husky:

  ```bash

  yarn prepare

### Commands

#### Linting

1. Check for linting issues:

  ```bash

  yarn lint

2. Fix linting and formatting issues:

  ```bash

  yarn lint:fix

#### Pre-Commit Hook

The pre-commit hook runs automatically when committing changes to .scss files. It performs the following steps:

- Formats staged .scss files using Prettier.

- Lints and fixes issues using Stylelint.

If linting issues cannot be fixed automatically, the commit will fail. You’ll need to resolve the issues manually before committing again.

##### Skipping the Pre-Commit Hook

To skip the pre-commit hook (not recommended):

  ```bash

  git commit --no-verify -m "Your commit message"