Skip to content

BaseCSS: A minimal, flexible CSS library for fast and responsive web design.

License

Notifications You must be signed in to change notification settings

MFM-347/BaseCSS

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

15 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

BaseCSS

Version Downloads Number of GitHub contributors GitHub commit activity GitHub release; latest by date Number of GitHub stars License MIT

BaseCSS is a minimal and flexible CSS library designed for fast, responsive, and maintainable web development. Ideal for developers looking for simplicity and scalability. 🌟🌐✨

Features

  • CSS Reset: Standardizes browser behavior for consistent styling.
  • Responsive Typography: Automatically adjusts font sizes for optimal readability on different screen sizes.
  • Minimal Styling: Provides a clean slate for building custom designs.

Using BaseCSS via NPM

Installation

To install the package, use the following command: πŸš€πŸ“¦πŸ’»

npm i @tfs-8/basecss

Importing

In Plain HTML:

Link the CSS file in your <head> tag: πŸ§ΎπŸ“‚πŸ–₯️

<link rel="stylesheet" href="node_modules/@tfs-8/basecss" />

In a JavaScript/TypeScript Project:

Import the CSS in your entry file: πŸ“œπŸ”—πŸ“¦

import "@tfs-8/basecss";

In SCSS:

If you're using SCSS: βœ‚οΈπŸŽ¨πŸ“„

@import "node_modules/@tfs-8/basecss";

Using BaseCSS via CDN

Installation

To use the CDN, link to the following URL: πŸŒπŸ“‘βœ¨

https://unpkg.com/@tfs-8/basecss

Importing

In Plain HTML:

Link the CSS file in your <head> tag: πŸ§ΎπŸŒπŸ”—

<link rel="stylesheet" href="https://unpkg.com/@tfs-8/basecss" />

In a JavaScript/TypeScript Project:

Import the CSS in your entry file: πŸ“₯πŸ“œπŸ”§

import "https://unpkg.com/@tfs-8/basecss";

In SCSS:

If you're using SCSS: πŸŽ¨πŸ“„βœ‚οΈ

@import "https://unpkg.com/@tfs-8/basecss";

Importing Specific Parts of BaseCSS

Instead of importing the entire compiled CSS file, you can include only the specific parts you need by importing the corresponding files from the dist folder. This allows for greater flexibility and reduced file size. πŸŽ―πŸ—‚οΈβš‘

Available Parts

  • vars: Variables for theming and custom properties.
  • reset: Browser style resets.
  • type: Responsive typography styles.
  • utilities: Utility classes for quick styling.
  • components: Predefined UI components.
  • scroll: Smooth scrolling and scrollbar styling.

Importing Specific Parts

In Plain HTML:

Link the desired CSS file in your <head> tag: πŸ“‚πŸ”—πŸ§Ύ

<link rel="stylesheet" href="node_modules/@tfs-8/basecss/dist/reset.min.css" />

In a JavaScript/TypeScript Project:

Import the specific section in your entry file: πŸ› οΈπŸ“œπŸ“¦

import "@tfs-8/basecss/dist/type.min.css";

In SCSS:

If you're using SCSS: βœ‚οΈπŸ“πŸŽ¨

@import "node_modules/@tfs-8/basecss/dist/utilities.min.css";

Getting Started

Once BaseCSS is imported, it will: πŸŒŸπŸ“πŸ’‘

  1. Reset the default browser styles for consistency.
  2. Apply responsive typography for better readability.
  3. Provide a clean slate for adding your custom styles.

You can now start building your styles on top of this foundation. πŸš€πŸŽ‰πŸ’»

Contributing

We welcome contributions! Please check the CONTRIBUTING.md for guidelines. πŸ€πŸ’‘πŸŒ±

Credits

Created with ❀️ by @MFM-347. πŸŽ¨πŸŒŸπŸ‘

License

The code in this repository is licensed under the MIT License. View more info here. πŸ“œβœ…πŸ–‹οΈ