README

PaperCSS

  The less formal CSS framework, with a quick and easy integration.


 Table of contents

- Table of contents
- Quick-start
- Content of the framework
- Documentation
- Customizing
- Contributing
- About
- Resources
- Credits and license

 Quick-start

There are several options available:

- You can download the latest release.
- Clone the repo: git clone https://github.com/papercss/papercss.git
- Install with npm: npm install papercss
- Install with yarn: yarn add papercss
- Import it using a CDN (it will automatically download the latest version):
  - https://unpkg.com/papercss/dist/paper.min.css
  - https://unpkg.com/papercss/dist/paper.css

 Content of the framework

We provide compiled CSS (paper.css) as well as minified CSS (paper.min.css).

You can choose which components you may want to use. Only the components that get imported into src/styles.scss will be compiled into dist/paper.css.

You can also play with original, source files, written in SCSS, in src/.

 Documentation

You can view the docs at getpapercss.com. Those are directly from the master branch; this means those features are stable and ready to be used in your project.

You can also view the develop branch at develop.getpapercss.com, this includes new features that are coming soon in the master branch. Be warned, a feature in develop can be removed without any prevention.

 Customizing

You can customize PaperCSS easily, clone the repo, run npm install and make any changes to .scss files in src/.

The main place you might want to make changes would be core/_config.scss, where you can specify new colors or fonts for your CSS build.

After you make changes, be sure to build the new CSS files. Do so by running npm run css:build and get them from the dist/ folder.

 Contributing

This project is open source and contributions are very welcomed. It is also as beginner friendly as possible, so don't be afraid to jump in if you've never contributed to any Git project before! Feel free to reach out if you are new and need help with the process.

Please before sending a PR, make sure you are properly using the .editorconfig file with your IDE. If your IDE doesn't natively support editorconfig files, you can use an extension/package/module. For example in Atom there is the editorconfig package, as well for Sublime Text, VS Code, Vim, ...

Once you are ready to contribute, here the workflow you should follow:

- Fork the repo then clone it: git clone [email protected]:[your_username]/papercss.git
- cd papercss then install dependencies: npm install
- Change your current branch to develop: git checkout develop
- Create your new branch where you will write your code: git checkout -b feature-thing develop. Please be sure to prepend your new feature branch with "feature-"
- Write some code!
- To build the scss (in src/) to css (in dist/), run npm run css:build. Note: you will need to re-run this command to include the latest changes in src/.
- To preview your changes, you can run npm