Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

External markdown: Mention that a http server is required #378

Closed
wants to merge 1 commit into from

2 participants

@jakubholynet

People may be surprised to find out nothing happens if they just
open a presentation html with an external markdown file using
the file:/// protocol, let them know they need a server for that.

Jakub Holy External markdown: Mention that a http server is required
People may be surprised to find out nothing happens if they just
open a presentation html with an external markdown file using
the file:/// protocol, let them know they need a server for that.
dea746b
@jakubholynet

PS: It would be perhaps good to also mention that --- surrounded by blank lines is the default vertical separator but I suppose you want to keep the document as short as possible and must people can figure it out anyway or just set their own separator ....

@hakimel
Owner

There's a few features that require the presentation to be running through a web server so it needs to be messaged more broadly rather than specifically for external markdown. Will make sure this is covered as the recommended setup for the whole framework as part of #357

@hakimel hakimel closed this
@jakubholynet

Great!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Mar 24, 2013
  1. External markdown: Mention that a http server is required

    Jakub Holy authored
    People may be surprised to find out nothing happens if they just
    open a presentation html with an external markdown file using
    the file:/// protocol, let them know they need a server for that.
This page is out of date. Refresh to see the latest.
Showing with 3 additions and 0 deletions.
  1. +3 −0  README.md
View
3  README.md
@@ -57,6 +57,9 @@ You can write your content as a separate file and have reveal.js load it at runt
<section data-markdown="example.md" data-separator="^\n\n\n" data-vertical="^\n\n"></section>
```
+Notice that this only works when serving the presentation and the markdown file over HTTP, from the same server (due to the same origin policy).
+If you have Python installed, you can run a HTTP server by executing `python -m SimpleHTTPServer` in this directory.
+
### Configuration
At the end of your page you need to initialize reveal by running the following code. Note that all config values are optional and will default as specified below.
Something went wrong with that request. Please try again.