FormidableLabs / FormidableLabs/spectacle

Very confused by the docs

Open
#886 7 comments 5 reactions 0 assignees View on GitHub
📖 Documentation 🤔 Question
Dominant language
TypeScript
Stars
10.2k
Forks
700
PR merge metrics
No merged PRs in 30d

Description

### Question

Hey guys, I just wanted to get started with spectacle, but the docs are confusing me quite a bit.
These are the issues i am having:

1. "Getting Started with Development" - this paragraph tells me, that all my source files have to be inside the `src/` dir. So far so good. But this also reads a bit like there should already be such a directory after installing spectacle with `yarn/npm`. I assume spectacle just wants me to create `src` myself? **Edit**: My bad - i completely missed the _Getting Started_ section. It might be benefitial to move _Getting Started_ before _Basic Concepts_.
2. The next part tells me to start a development server with ominous npm-scripts which are not yet part of my package.json. Instead I should look inside `examples/js` - I realize these are part of the spectacle repository. But how am I supposed to access these just after running `yarn add spectacle`? Ofcourse I could look inside my node_modules, but is this what you want users to actually do?
3. Is there a way to use spectacle with multiple markdown or even js/jsx files? I can't seem to find anything inside the docs

Thanks in advance :)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.