Skip to content

Commit

Permalink
update deprecated README
Browse files Browse the repository at this point in the history
  • Loading branch information
patarapolw committed Nov 24, 2019
1 parent e1a993f commit b32bb65
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 12 deletions.
4 changes: 0 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,6 @@ Options:

By default, media can be put in the folder `media/` alongside the `*.md` file. The media can be referenced using the URL `/media/<FILENAME>`. Can be disabled using `--no-media` flag.

## Adding plugins to reveal-md

Also `plugin/` folder alongside `*.md` file will be loaded. Can be disabled using `--no-plugin` flag. For example, see <https://github.com/patarapolw/flatsrs>

## Global and Hidden slides

- Global scripting `<script></script>` and styling `<style></style>` is supported in slides marked with
Expand Down
2 changes: 2 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
"scripts": {
"start": "node ./bin/cli.js .",
"help": "node ./bin/cli.js --help",
"build": "cd web && npm run build",
"deploy": "cd web && npm run gh:deploy",
"preinstall": "git submodule update --init --recursive && cd ./web && npm i && npm run build",
"test": "echo \"Error: no test specified\" && exit 1"
},
Expand Down
6 changes: 0 additions & 6 deletions web/readme-slides.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,12 +94,6 @@ By default, media can be put in the folder `media/` alongside the `*.md` file. T

===

## Adding plugins to reveal-md

Also `plugin/` folder alongside `*.md` file will be loaded. Can be disabled using `--no-plugin` flag. For example, see <https://github.com/patarapolw/flatsrs>

===

## Save as HTML (and associated assets folder)

This is best done by [downloading complete web page, in associated web browser](https://www.makeuseof.com/tag/save-complete-webpage-offline-reading/).
Expand Down
6 changes: 4 additions & 2 deletions web/vue.config.js
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
const fs = require("fs");
const path = require("path");

let baseUrl = "/";

if (process.env.GITHUB) {
const exampleFile = path.join(__dirname, "readme-slides.md");
process.env.VUE_APP_PLACEHOLDER = fs.readFileSync(exampleFile, "utf-8");
process.env.VUE_APP_TITLE = exampleFile;
}

const baseUrl = "/";
baseUrl = "/reveal-md/";
}

process.env.VUE_APP_REVEAL_CDN = (
fs.existsSync(path.join(__dirname, "public", "reveal.js")) &&
Expand Down

0 comments on commit b32bb65

Please sign in to comment.