Skip to content

Commit 45a91fb

Browse files
authored
Update docs to include !raw-loader! hack (FormidableLabs#681)
* Update markdown section to include `!raw-loader!` hack Without the leading '!', the slides are not properly formatted. FormidableLabs#467 * Run prettier-fix
1 parent c21b5c9 commit 45a91fb

File tree

2 files changed

+9
-8
lines changed

2 files changed

+9
-8
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ What machine are you on?
3232

3333
It's easier to show us than tell us what's going wrong with your code. Because of this, we ask that you do one of three things to help us reproduce the bug:
3434

35-
1. Create a public minimal repository that we can `git clone`, with install + error reproduction steps in the README.
36-
2. Fork our [simple Spectacle sample Sandbox](https://codesandbox.io/s/7wo8xv8nw0), reproduce your issue in the code, and paste the link here.
37-
3. Open up a PR, include "WIP" and the Issue # in the title, and point us to the failing regression tests.
35+
1. Create a public minimal repository that we can `git clone`, with install + error reproduction steps in the README.
36+
2. Fork our [simple Spectacle sample Sandbox](https://codesandbox.io/s/7wo8xv8nw0), reproduce your issue in the code, and paste the link here.
37+
3. Open up a PR, include "WIP" and the Issue # in the title, and point us to the failing regression tests.
3838

3939
**Expected behavior:** [What you expect to happen]
4040

README.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -76,17 +76,17 @@ First, decide whether you want to use [classic Spectacle](#classic-spectacle), [
7676

7777
There are four ways to get started building your presentation.
7878

79-
1. **Option #1:** Run the following command in your terminal:
79+
1. **Option #1:** Run the following command in your terminal:
8080

81-
`npx create-react-app my-presentation --scripts-version spectacle-scripts`
81+
`npx create-react-app my-presentation --scripts-version spectacle-scripts`
8282

83-
2. **Option #2:** Using the [Spectacle Boilerplate](https://github.com/FormidableLabs/spectacle-boilerplate).
83+
2. **Option #2:** Using the [Spectacle Boilerplate](https://github.com/FormidableLabs/spectacle-boilerplate).
8484

85-
3. **Option #3:** Following along the [Spectacle Tutorial](./docs/tutorial.md), which also involves downloading the [Spectacle Boilerplate](https://github.com/FormidableLabs/spectacle-boilerplate).
85+
3. **Option #3:** Following along the [Spectacle Tutorial](./docs/tutorial.md), which also involves downloading the [Spectacle Boilerplate](https://github.com/FormidableLabs/spectacle-boilerplate).
8686

8787
All three of the above ways will give you everything you'll need to get started, including a sample presentation in the `presentation` folder. You can change the props and tags as needed for your presentation or delete everything in `presentation/index.js` to start from scratch. From here you can go to [Development](#development) to get started.
8888

89-
3. **Option #4:** Run `npm install spectacle` in your terminal and writing your own build configurations. We also provide full UMD builds (with a `Spectacle` global variable) of the library at `dist/spectacle.js` and `dist/spectacle.min.js` for more general use cases. You could, for example, include the library via a script tag with: `https://unpkg.com/spectacle@VERSION/dist/spectacle.min.js`.
89+
3. **Option #4:** Run `npm install spectacle` in your terminal and writing your own build configurations. We also provide full UMD builds (with a `Spectacle` global variable) of the library at `dist/spectacle.js` and `dist/spectacle.min.js` for more general use cases. You could, for example, include the library via a script tag with: `https://unpkg.com/spectacle@VERSION/dist/spectacle.min.js`.
9090

9191
### Spectacle MDX
9292

@@ -603,6 +603,7 @@ Slide Content
603603
`;
604604

605605
....
606+
import slidesMarkdown from "!raw-loader!markdown.md";
606607

607608
<Deck ...>
608609
{MarkdownSlides(slidesMarkdown)}

0 commit comments

Comments
 (0)