Skip to content

Commit

Permalink
document how to get started; fixes #65
Browse files Browse the repository at this point in the history
  • Loading branch information
bast committed Nov 12, 2018
1 parent 4ff970f commit c5e08dc
Show file tree
Hide file tree
Showing 2 changed files with 67 additions and 0 deletions.
60 changes: 60 additions & 0 deletions doc/getting_started.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@


Getting started in 5 minutes
============================

Place the following Markdown file on https://github.com or https://gitlab.com,
perhaps as ``mytalk.md``::

class: center, middle

# Simple example presentation

## Author

---

## Another slide

Try **F** and **P** keys.

- A bullet point
- Another convincing argument

---

## Code blocks are no problem

Here we have some Python code:

```python
from itertools import cycle

fizz = cycle(['', '', 'Fizz'])
buzz = cycle(['', '', '', '', 'Buzz'])

for i in range(1, 101):
print((next(fizz) + next(buzz)) or i)
```

[Source](https://github.com/olemb/nonsense/blob/master/fizzbuzz/itertools_cycle.py)

---

## Images

An image fetched from the web:

![Sample image](https://upload.wikimedia.org/wikipedia/commons/thumb/4/4f/The_Young_Cicero_Reading.jpg/316px-The_Young_Cicero_Reading.jpg)

Let us assume your talk is on (replace ``<namespace>`` and ``<repository>``)::

https://github.com/<namespace>/<repository>/mytalk.md

You can now visit (replace ``<namespace>`` and ``<repository>``)::

https://cicero.xyz/v3/remark/0.14.0/github.com/<namespace>/<repository>/master/mytalk.md

Of course you can reference another branch or tag or hash than ``master``.

If you like https://revealjs.com better, then check https://github.com/bast/cicero/tree/master/demo/reveal.js.
7 changes: 7 additions & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,13 @@ before you can say blueberry pie.
You can **style your slides** to your heart's content.


.. toctree::
:maxdepth: 1
:caption: First steps

getting_started.rst


.. toctree::
:maxdepth: 1
:caption: Local preview
Expand Down

0 comments on commit c5e08dc

Please sign in to comment.