Skip to content

Commit 0cb7230

Browse files
committed
Add instructions to preview through an HTTP server and use Prince to generate PDF.
1 parent 757c884 commit 0cb7230

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,14 @@ writing ISO C++ documents and papers. To use it for your document, you should
88
2. Install this package by running `bower install cplusplus/html-doc-framework` in the root directory of your document.
99
3. Import this package into your main HTML file by adding two lines inside the `<head>` element:
1010

11-
```HTML
12-
<script src="bower_components/platform/platform.js"></script>
13-
<link rel="import" href="bower_components/cxx-html-doc-framework/framework.html"/>
14-
```
11+
```HTML
12+
<script src="bower_components/platform/platform.js"></script>
13+
<link rel="import" href="bower_components/cxx-html-doc-framework/framework.html"/>
14+
```
15+
16+
4. Run an HTTP server (e.g. [`python3 -m http.server`](https://docs.python.org/3/library/http.server.html#http-server-cli) or [`http-server`](https://www.npmjs.org/package/http-server)) in the directory of your main HTML file, and preview through that instead of a `file:///` URL.
17+
18+
I recommend the [Prince rendering engine](http://www.princexml.com/) for converting your HTML file to PDF. It has significantly better support for page-related features than any browser as of 2014.
1519

1620
Before I can accept a contribution to this project, you'll need to sign the
1721
Contributor License Agreement at https://developers.google.com/open-source/cla/individual.

0 commit comments

Comments
 (0)