Skip to content

Commit

Permalink
add: instruction for linkcss in README
Browse files Browse the repository at this point in the history
  • Loading branch information
houqp committed Feb 9, 2012
1 parent 494c7d1 commit daab5da
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,21 +28,23 @@ You can also use this backend without installation, see the next section.

## Usage

With deckjs backend installed, use following command to generate slides:
* With deckjs backend installed, use following command to generate slides:

```bash
asciidoc -b deckjs file.asciidoc
```

To use without Installation, you need to specify different argument:
By default, the `linkcss` option is disabled so all the required js and css file will be embedded into the output slide. Checkout the [template file][example] for how to enable all kinds of options.

* To use without Installation, you need to specify different argument:

```bash
asciidoc -f deck.js.conf file.asciidoc
```

Make sure your asciidoc can properly find `deckjs.conf`. For asciidoc's configuration file loading strategy, please refer to [this guide][asc-conf-guide].

Note that without installation, you also have to enable `linkcss` option. Then put `deck.js`, `ad-stylesheet` and generated slide into the same directory. Checkout the [template file][example] for how to enable all kinds of options.
Note that without installation, you also have to enable `linkcss` option. Then put `deck.js`, `ad-stylesheet` and generated slide into the same directory.



Expand Down

0 comments on commit daab5da

Please sign in to comment.