dillonkearns/elm-pages-v3-beta
1
1
Fork 0
mirror of https://github.com/dillonkearns/elm-pages-v3-beta.git synced 2024-12-25 04:43:03 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update instructions.

Browse Source
This commit is contained in:
Dillon Kearns 2021-04-17 14:34:39 -07:00
parent 4534b6689a
commit 2a065c5455
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/2.0-alpha-instructions.md
View File

@ -11,6 +11,16 @@ getting the documentation ready, and changing APIs wherever things appear to be
Feedback and documentation improvements are very welcome.
## Installation
The alpha isn't published on `npm`, so the two ways to set it up are by working directly in this git repository, or by pulling this repository down
as a git submodule.
If you work directly within this repository, you can copy-paste one of the `examples/` projects and tweak that. Then you can pull in the latest code to tweak it.
To install it as a git submodule, you can do `git submodule add https://github.com/dillonkearns/elm-pages && cd elm-pages && git checkout static-files`.
Then you need to install the NPM pacakge from the top-level project with `npm install ./elm-pages`. Then make sure you include `./elm-pages/src` in your `source-directories` in your `elm.json`.
### Special files
- `Document.elm` - defines the types for your applications view. Can expose any type called `Document msg` (must have exactly one type variable)