From b81ad953f3c68f90430e7eef06ab81049ed1fe04 Mon Sep 17 00:00:00 2001 From: suterma Date: Sun, 17 Jul 2022 23:59:03 +0200 Subject: [PATCH] added examples --- README.md | 40 ++++++++++++++++++++++++++++++---------- 1 file changed, 30 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 4c08408..d703669 100644 --- a/README.md +++ b/README.md @@ -37,33 +37,53 @@ To arrange the print layout of your pages, you can add the following classes to The class names follow the naming pattern from the visibility helpers, as per the [Bulma documentation](https://bulma.io/documentation/helpers/visibility-helpers/). +### Examples -## What's included +```html + + +``` -This package contains: +```html + +
+ +
+``` - - a main Scss file, `bulma-print.scss` which includes the styles for the above classes. - - Additional, experimental styles in the `experimental` folder. Use with caution. - - a pre-compiled .css file, if you do not want to build from .scss +```html + +

Try it out!

+``` -## Further considerations +### Further considerations -### Printed links +#### Printed links Bulma-print will by default add the hyperlink URL (`href`) after any `a` (anchor) element. Otherwise, hyperlinks are not usable from print media. If you do not like this for a link, you can suppress this via the specific marker class `is-not-linked-print`. -### Page breaks +#### Page breaks Print media has the additional concept of pages. The page breaks can be controlled and specifically set, for example you can add `has-page-break-before` on `h1` elements, to add a page break beforehand, to produce a more expected layout on print media. Also, for enumerations like lists or with tables, you might want to keep these on the same page, and can thus use `is-together-print` on the outermost element, like `ul` or `table`. -### Responsive size +#### Responsive size For printing, Bulma by default uses the layout styles as for their "tablet" screen size. See the [Bulma breakpoint documentation](https://bulma.io/documentation/overview/responsiveness/#breakpoints). This package does not change this. -### Automatic color adjustments +#### Automatic color adjustments Any browser may try to optimize the printed colors as it sees fit, and most browsers do. See the documentation about the [`print-color-adjust` CSS property](https://developer.mozilla.org/docs/Web/CSS/print-color-adjust) for more information. Bulma-print does not change this value. You may want to add your custom styles to produce the exact output you like. +## What's included + +This package contains: + + - a main Scss file, `bulma-print.scss` which includes the styles for the above classes. + - Additional, experimental styles in the `experimental` folder. Use with caution. + - a pre-compiled .css file, if you do not want to build from .scss + ## Build Use `npm run` to show all available commands: