1. Download
Before downloading, be sure to have a code editor (we recommend Visual Studio Code) and some working knowledge of HTML and CSS. We won't walk through the source files here, but they are available for download. We'll focus on getting started with the compiled Piment files.
Download compiled
Fastest way to get started: get the compiled and minified versions of our CSS, JS, and images. No docs or original source files.
Download PimentDownload source
Get the original files for all CSS and JavaScript, along with a local copy of the docs by downloading the latest version.
Download Piment source2. File structure
Within the download you'll find the following file structure and contents, logically grouping common assets and providing both compiled and minified variations.
Once downloaded, unzip the compressed folder to see the structure of (the compiled) Piment. You'll see something like this: piment/
├── public/
├──── assets/
├────── css/
│──────── piment.css
│──────── piment.min.css
├────── img/
│──────── logo-pimentcss.svg
This is the most basic form of Piment: compiled files for quick drop-in usage in nearly any web project. We provide compiled CSS and JS (piment.*), as well as compiled and minified CSS and JS (piment.min.*).
Please note that all JavaScript plugins require jQuery to be included.
3. What's included
Piment comes equipped with HTML, CSS, and JS for all sorts of things, but they can be summarized with a handful of categories visible at the top of the Piment documentation.
Docs sections
Scaffolding
Global styles for the body to reset type and background, link styles, grid system, and two simple layouts.
Base CSS
Styles for common HTML elements like typography, code, tables, forms, and buttons.
Components
Basic styles for common interface components like tabs and pills, navbar, alerts, page headers, and more.
List of components
Together, the Components provide the following interface elements:
- Typography
- Responsive Grid
- Form
- Buttons
- Media
- Card
- Utilities
For the next releases
- Navigational tabs, pills, and lists
- Navbar
- Labels
- Badges
- Page headers and hero unit
- Alerts
- Dropdowns
- Accordion
- Carousel
In future guides, we may walk through these components individually in more detail. Until then, look for each of these in the documentation for information on how to utilize and customize them.
4. Basic HTML template
With a brief intro into the contents out of the way, we can focus on putting Piment to use. To do that, we'll utilize a basic HTML template that includes everything we mentioned in the File structure.
Now, here's a look at a typical HTML file:<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Piment Template</title>
<meta name="description" content="Piment is a CSS framework for faster and easier web development.">
</head>
<body>
<h1>Hello, world!</h1>
</body>
</html>
To make this a Pimented template, just include the appropriate CSS and JS files:
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Piment Template</title>
<meta name="description" content="Piment is a CSS framework for faster and easier web development.">
<!-- Piment -->
<link href="assets/css/piment.min.css" rel="stylesheet" media="screen">
</head>
<body>
<h1>Hello, world!</h1>
</body>
</html>
And you're set! With those two files added, you can begin to develop any site or application with Piment.