Skip to content

Commit ed02651

Browse files
committed
🎉
0 parents  commit ed02651

38 files changed

+5636
-0
lines changed
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Sample workflow for building and deploying a website to GitHub Pages
2+
name: Deploy to GitHub Pages
3+
4+
on:
5+
# Runs on pushes targeting the default branch
6+
push:
7+
branches: [ "main" ]
8+
9+
# Allows you to run this workflow manually from the Actions tab
10+
workflow_dispatch:
11+
12+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
13+
permissions:
14+
contents: read
15+
pages: write
16+
id-token: write
17+
18+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
19+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
20+
concurrency:
21+
group: "pages"
22+
cancel-in-progress: false
23+
24+
jobs:
25+
# Build job
26+
build:
27+
runs-on: ubuntu-latest
28+
steps:
29+
- name: Checkout
30+
uses: actions/checkout@v4
31+
- name: Setup Pages
32+
uses: actions/configure-pages@v5
33+
- name: Install dependencies
34+
run: |
35+
npm ci
36+
- name: Build website
37+
run: |
38+
npm run build:website
39+
- name: Upload artifact
40+
uses: actions/upload-pages-artifact@v3
41+
with:
42+
path: website-dist
43+
44+
# Deployment job
45+
deploy:
46+
environment:
47+
name: github-pages
48+
url: ${{ steps.deployment.outputs.page_url }}
49+
runs-on: ubuntu-latest
50+
needs: build
51+
steps:
52+
- name: Deploy to GitHub Pages
53+
id: deployment
54+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Artifacts
2+
3+
## Build related
4+
dist/
5+
website-dist/
6+
7+
.cache
8+
.tsbuildinfo
9+
**/*.js
10+
**/*.mjs
11+
**/*.cjs
12+
**/*.map
13+
**/*.d.ts
14+
*.tsbuildinfo
15+
16+
!buildscript
17+
!buildscript/*
18+
!buildscript/**/*
19+
20+
## Coverage directory
21+
coverage/
22+
23+
# Dependency directories
24+
node_modules/
25+
26+
# Log files
27+
logs
28+
*.log
29+
npm-debug.log*
30+
yarn-debug.log*
31+
yarn-error.log*
32+
33+
34+
35+
# OS specific files
36+
37+
## Runtime data
38+
pids
39+
*.pid
40+
*.seed
41+
*.pid.lock
42+
43+
44+
45+
# IDEs specific files
46+
47+
## Covers WebStorm
48+
.idea/*
49+
!.idea/codeStyles
50+
.idea/codeStyles/*
51+
!.idea/codeStyles/Project.xml
52+
!.idea/codeStyles/codeStyleConfig.xml
53+
54+
modules.xml
55+
*.iml
56+
*.ipr
57+
58+
## Covers Visual Studio Code
59+
.vscode/*
60+
!.vscode/settings.json
61+
!.vscode/tasks.json
62+
!.vscode/launch.json
63+
!.vscode/extensions.json
64+
.history
65+
66+
!/travicdebug.js

CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/ @mzpkdev

CODE_OF_CONDUCT.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for
6+
everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity
7+
and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste,
8+
color, religion, or sexual identity and orientation.
9+
10+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to a positive environment for our community include:
15+
16+
- Demonstrating empathy and kindness toward other people
17+
- Being respectful of differing opinions, viewpoints, and experiences
18+
- Giving and gracefully accepting constructive feedback
19+
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
20+
- Focusing on what is best not just for us as individuals, but for the overall community
21+
22+
Examples of unacceptable behavior include:
23+
24+
- The use of sexualized language or imagery, and sexual attention or advances of any kind
25+
- Trolling, insulting or derogatory comments, and personal or political attacks
26+
- Public or private harassment
27+
- Publishing others’ private information, such as a physical or email address, without their explicit permission
28+
- Other conduct which could reasonably be considered inappropriate in a professional setting
29+
30+
## Enforcement Responsibilities
31+
32+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take
33+
appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive,
34+
or harmful.
35+
36+
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits,
37+
issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for
38+
moderation decisions when appropriate.
39+
40+
## Scope
41+
42+
This Code of Conduct applies within all community spaces,
43+
and also applies when an individual is officially representing the community in public spaces.
44+
Examples of representing our community include using an official email address,
45+
posting via an official social media account, or acting as an appointed representative at an online or offline event.
46+
47+
## Enforcement
48+
49+
Instances of abusive, harassing, or otherwise unacceptable behavior may
50+
be reported to the community leaders responsible for enforcement by opening a private GitHub discussion.
51+
All complaints will be reviewed and investigated promptly and fairly.
52+
53+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
54+
55+
## Attribution
56+
57+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1,
58+
available at
59+
https://www.contributor-covenant.org/version/2/1/code_of_conduct/

CONTRIBUTING.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Contributing
2+
3+
Thank you for your interest in helping improve `outlinecss`!
4+
Whether you want to improve documentation, suggest features, or fix bugs,
5+
this guide will help you get started. 🎉
6+
7+
## Development Setup
8+
9+
1. Just clone this repository to you computer.
10+
2. Then just type `npm install` and hit enter to install all the required dependencies.
11+
12+
## Making Changes
13+
14+
1. Firstly, create a branch for your changes.
15+
- Use descriptive names like `feat/add-superior-button-component` or `fix/increase-tooltip-z-index`
16+
2. Then, when you're ready, just push your branch and create a pull request.
17+
3. Now there's nothing more to do, but just to wait for review and address any feedback.
18+
19+
## Need help or have ideas?
20+
21+
- Check the open issues first.
22+
- If your problem is there, add a comment or up-vote.
23+
- If not there, create a new issue. Be as descriptive as possible.
24+
25+
---
26+
27+
Thanks for contributing to `outlinecss`!

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Mateusz Pietrzak
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
<div align="center">
2+
3+
[![license](https://img.shields.io/npm/l/outlinecss.svg)](https://github.com/mzpkdev/outlinecss/blob/master/LICENSE)
4+
[![npm version](https://img.shields.io/npm/v/outlinecss.svg)](https://www.npmjs.com/package/outlinecss)
5+
[![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue.svg)](https://www.typescriptlang.org/)
6+
[![bundle size](https://img.shields.io/bundlephobia/min/outlinecss)](https://bundlephobia.com/result?p=outlinecss)
7+
8+
</div>
9+
<br>
10+
<br>
11+
12+
<p align="center">
13+
<strong>Outline</strong>
14+
<p align="center">
15+
A headless, responsive, and composable CSS framework designed for easy customization.
16+
<br />
17+
<br />
18+
<a href="https://github.com/mzpkdev/outlinecss/issues">Report a bug</a>
19+
&nbsp;&nbsp;·&nbsp;&nbsp;
20+
<a href="https://github.com/mzpkdev/outlinecss/issues">Request a feature</a>
21+
</p>
22+
<br />
23+
<br />
24+
25+
Table of Contents
26+
------------------
27+
28+
* [Getting started](#getting-started)
29+
* [How to install](#how-to-install)
30+
31+
Getting started
32+
----------------
33+
34+
### How to install
35+
36+
```shell
37+
npm install outlinecss
38+
```

SECURITY.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
We take security seriously and appreciate responsible disclosure.
6+
If you discover a security vulnerability, please follow these steps:
7+
8+
1. **Do not** create a public issue or disclose the vulnerability publicly.
9+
2. In this repository, click the **Security** tab at the top.
10+
3. Click the **Report a vulnerability** button.
11+
4. Fill out the form with details such as:
12+
- Description of the vulnerability
13+
- Steps to reproduce
14+
- Potential impact
15+
- Suggested fix (if you have one)
16+
17+
## Response Timeline
18+
19+
- We will acknowledge your report within 3 business days.
20+
- We will provide an initial assessment within 7 business days.
21+
- Critical security issues will be prioritized and addressed as quickly as possible.
22+
- We may create a private branch or fork to resolve the issue and may invite you to collaborate.
23+
24+
## Thank You
25+
26+
Thank you for helping keep `outlinecss` secure! Responsible disclosure helps protect everyone using this project.

bin/run

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
#!/usr/bin/env node
2+
3+
require("../lib/main.js")

bin/run.cmd

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
mkvbot@echo off
2+
3+
node "%~dp0\run" %*

0 commit comments

Comments
 (0)