## File: README.md
# [sakura](https://oxal.org/projects/sakura): a minimal, ***classless*** CSS *framework* / **theme**.
[![npm][npm-image]][npm-url]
[npm-image]: https://img.shields.io/npm/v/sakura.css.svg?colorB=982c61
[npm-url]: https://www.npmjs.com/package/sakura.css
[Go to [GitHub repository](https://github.com/oxalorg/sakura)]
> The perfect blossom is a rare thing. You could spend your life looking for
> one, and it would not be a wasted life.
Just drop `sakura.css` into any webpage and go from an ugly-looking 1900s
website to a pretty, modern website in literally 0 seconds.
It's easy to customize and build on top of sakura.
Sakura supports extremely easy theming using variables for duotone color
scheming. It comes with several existing themes, which can be found in the `css`
folder of this repository.
## Demo
Compare a live page **WITH** and **WITHOUT** sakura.
* [https://oxal.org/projects/sakura/demo](https://oxal.org/projects/sakura/demo)
Also, my blog is a nice place to check sakura in action with heavy text (it has
a "change theme" button on the top as well):
* [oxal.org/blog](https://oxal.org/blog/)
## Bookmark
Don't want to develop using sakura but instead want to use it on websites with
outdated 90s design (i.e. no CSS)?
If so, enable sakura on any website using the following
instructions:
* [https://oxal.org/projects/sakura/bookmark](https://oxal.org/projects/sakura/bookmark)
## Why? - Reasons to use sakura
How exactly does sakura help you? I had a discussion about this on the
[reddit thread](https://www.reddit.com/r/webdev/comments/68zpdp/sakura_a_minimal_classless_css_theme_just_drop_it/).
- Just drop it in, even on existing HTML content, to get a pretty-looking
website (everything *"just works"*)
- Quick prototyping, especially when working on backend sites and can't yet be
bothered to fidget with CSS/HTML
- Building a quick (but pretty) site/blog for your best friend or aunt!
- No need to remember tons of different class names for every other CSS
framework
- Works amazingly with markdown-generated HTML pages (eliminates the need for
hacks like including `.img img-responsive` in `` tags generated
from markdown-parser
- Wonderful for people who aren't really good or interested in design as sakura
is nothing but a set of reasonable defaults
## Installation
**CDN** (*recommended*):
1. Simply add this in your `` tag:
```html
```
**Manually**:
1. Download the file:
```bash
wget "https://raw.githubusercontent.com/oxalorg/sakura/master/css/sakura.css"
```
**OR** download directly:
[sakura.css](https://raw.githubusercontent.com/oxalorg/sakura/master/css/sakura.css)
2. Link it from HTML:
```html
```
**Package Manager**:
1. Install from npm:
```bash
npm install sakura.css
```
2. Install from Yarn:
```bash
yarn add sakura.css
```
**(Optional)** *but recommended* to use
[normalize.css](https://github.com/necolas/normalize.css/)
to reset *before* using sakura.
## Sites using sakura
* [https://oxal.org/blog/](https://oxal.org/blog/)
* [http://computableverse.com](http://computableverse.com)
* [https://gaiwan.co](https://gaiwan.co)
* [https://www.softwareyoga.com/](https://www.softwareyoga.com)
* [https://www.taazakitchen.com/](https://www.taazakitchen.com)
* [https://audioviz.surge.sh/vex.html](https://audioviz.surge.sh/vex.html)
* [https://chocopy.org](https://chocopy.org)
* [https://wasmbyexample.dev/](https://wasmbyexample.dev/)
* [https://ninjas.cl/](https://ninjas.cl/)
* [https://minidown.atusy.net](https://minidown.atusy.net)
* [https://jvanelian.dev](https://jvanelian.dev)
* [https://mousikofidi.info/](https://mousikofidi.info/)
* [https://ocamlbook.org](https://ocamlbook.org)
* [https://monkeyjunglejuice.github.io](https://monkeyjunglejuice.github.io)
* [https://reinforce.moe/about-en.md](https://reinforce.moe/about-en.md)
* [https://4clojure.oxal.org/](https://4clojure.oxal.org/)
* [https://yunru.se](https://yunru.se)
* [https://articleparser.vercel.app/](https://articleparser.vercel.app/)
* [https://bluelander.bearblog.dev/](https://bluelander.bearblog.dev/)
* [https://onefetch.dev/](https://onefetch.dev/)
* [https://nonwiz.dev/](https://nonwiz.dev)
* [https://frost.kiwi/](https://frost.kiwi)
* [https://kylenazario.com](https://kylenazario.com)
* [https://progress.jackkershaw.net](https://progress.jackkershaw.net)
* [https://bigdetector.com/](https://bigdetector.com/)
* [https://chordtransposer.val.run](https://chordtransposer.val.run)
***If you're using sakura, please let me know or make a pull request adding in
your name. I would be super happy!! `^_^`***
## Theming
You can make your own themes by overriding some variables for colors.
Here is an example file: `./scss/sakura-earthly.scss`:
```scss
/* Duotone color scheming:
Uses blossom as the revealing/stark color
Uses fade as the more prominent color
*/
$color-blossom: #338618;
$color-fade: #5e5e5e;
/* bg color is used for the background of the page
bg-alt is used for code-blocks etc
*/
$color-bg: #f9f9f9;
$color-bg-alt: #C7E3BE;
/* color of all the text on the page */
$color-text: #4a4a4a;
$font-size-base: 1.8rem;
@import "main";
```
## Dark mode
Add a media attribute as follows to choose a darker theme for dark mode.
```
```
## Contributing
Please have a look at the [instructions](CONTRIBUTING.md).
## Contributors
* Bookmarklet was added by [Zhouzi](https://github.com/Zhouzi).
* The image is credited to
[Deedster](https://pixabay.com/en/users/Deedster-2541644/).
* Vite previews added by @spenserblack [SpenserBlack](https://github.com/spenserblack).
## Share some <3
> Between our two lives there is also the life of the cherry blossom.
> - *Basho Matsuo*
Please leave a star. :)
---
## File: docs/publishing.md
# Publishing to NPM
### New automated way
* Open `package.json`, up the version number
* Make sure nothing else is changed in the working tree
* Run `npm run release`
### Manual OLD way
I'll mostly be doing this manually, but I keep forgetting the steps.
* Make sure you're logged in using `npm login`
* Update `CHANGELOG.md` file
* Change version numbers in the following files
- `scss/_main.css`
- `package.json`
* Make sure to build css files again `npm run scss` so that they have the updated version numbers
* Publish `npm publish`
* `git tag -a $VERSION -m "Release $VERSION"`
* `git push --tags`