Update README.md
This commit is contained in:
parent
b9e9c36732
commit
955ca9f1ee
1 changed files with 15 additions and 4 deletions
19
README.md
19
README.md
|
@ -41,16 +41,16 @@ $ hugo new site my-presentation
|
|||
|
||||
*Note: if you wish to add a Reveal.js presentation to an existing Hugo site without changing its theme, you can see [an example here](https://github.com/dzello/dzello-dot-com).*
|
||||
|
||||
Change into the themes directory of the new site:
|
||||
Change into the directory of the new site:
|
||||
|
||||
```shell
|
||||
$ cd my-presentation/themes
|
||||
$ cd my-presentation
|
||||
```
|
||||
|
||||
Clone this theme:
|
||||
Clone this repository into the themes directory:
|
||||
|
||||
```shell
|
||||
$ git clone git@github.com:dzello/reveal-hugo.git
|
||||
$ git clone git@github.com:dzello/reveal-hugo.git themes/reveal-hugo
|
||||
```
|
||||
|
||||
Create a file in `content/_index.md` with this contents:
|
||||
|
@ -75,6 +75,17 @@ Navigate to [http://localhost:1313/](http://localhost:1313/) and you should see
|
|||
|
||||
![New site with reveal-hugo](/images/reveal-hugo-hello-world.png)
|
||||
|
||||
To add more slides, just add content to `_index.md`. Remember to separate each slide separated by `---` surrounded by newlines.
|
||||
|
||||
```markdown
|
||||
|
||||
---
|
||||
|
||||
# Hello Mars!
|
||||
|
||||
This is the second slide.
|
||||
```
|
||||
|
||||
### Presentation structure
|
||||
|
||||
To create the default presentation (the one that will live at the site root), the theme will look for a `content/_index.md` file and any pages that have a type of `home`. That means they're in a `home` directory in the `content` folder OR the type is manually set to `home` in the front matter.
|
||||
|
|
Loading…
Reference in a new issue