README.md 1.69 KB
Newer Older
Julie Blanc's avatar
Julie Blanc committed
1 2 3 4
# Paged.js documentation



Julie Blanc's avatar
Julie Blanc committed
5
## Part 1: Getting Started with Paged.js [ [link](https://gitlab.pagedmedia.org/tools/pagedjs-documentation/blob/master/Part01_Getting-Started-with-paged.md) ]
Julie Blanc's avatar
Julie Blanc committed
6 7

- A quick presentation of paged.js
Julie Blanc's avatar
Julie Blanc committed
8
  - Visual preview and command line version
Julie Blanc's avatar
Julie Blanc committed
9 10 11 12 13 14 15 16
  - W3C specifications
  - A community
- Running paged.js
  - Access to paged.js script
  - Use a local server
  - Which browser to use?
- Generating a PDF
  - Option 1: with a browser
17
  - Option 2: with pagedjs-cli
Julie Blanc's avatar
Julie Blanc committed
18
- Using an interface (ToDo)
19

20

Julie Blanc's avatar
Julie Blanc committed
21
## Part 2: How Paged.js works  [ [link](https://gitlab.pagedmedia.org/tools/pagedjs-documentation/blob/master/Part02_how-pagedjs-works.md) ]
22

Julie Blanc's avatar
Julie Blanc committed
23 24 25 26 27 28 29
* W3C CSS modules
* Support of W3C specifications in browsers
* The paged.js library
* The Chunker: fragment the content
* The Polysher: polyfill the print declarations
* The Previewer: pagined rendering
* DOM modifications
Julie Blanc's avatar
Julie Blanc committed
30

Julie Blanc's avatar
Julie Blanc committed
31 32


Julie Blanc's avatar
Julie Blanc committed
33
## Part 3: Interface [ [link](https://gitlab.pagedmedia.org/tools/pagedjs-documentation/blob/master/Part03_Interface.md) ]
Julie Blanc's avatar
Julie Blanc committed
34 35 36 37



## Part 4: Global Layout  [ [link](https://gitlab.pagedmedia.org/tools/pagedjs-documentation/blob/master/Part04_Global-Layout.md) ]
38 39 40 41 42 43 44

- Print media query 
- @page rule
- Page size property
- Margin size property
- Page spread or recto/verso
- Page breaks
45
- Pseudo class selectors for pages
46 47 48
- Crop marks and bleed 
- Code resume of the chapter

Julie Blanc's avatar
Julie Blanc committed
49

Julie Blanc's avatar
Julie Blanc committed
50
## Part 5: Generated Content [ [link](https://gitlab.pagedmedia.org/tools/pagedjs-documentation/blob/master/Part05_Generated-Content.md) ]
Julie Blanc's avatar
Julie Blanc committed
51 52 53 54 55 56 57 58

- The content property
- Generated text
- Generated counters
- Generated images
- Generated links
- Generated content for paged media

59 60
  

61
## FAQ [ [link](https://gitlab.pagedmedia.org/tools/pagedjs-documentation/blob/master/FAQ.md) ]