Skip to content

Commit

Permalink
Update scripts and README
Browse files Browse the repository at this point in the history
  • Loading branch information
alfonsogarciacaro committed Oct 29, 2018
1 parent 7b009f3 commit e234caf
Show file tree
Hide file tree
Showing 3 changed files with 584 additions and 10 deletions.
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,10 @@
# [Fable website](http://fable.io) generator

This project generates the static web pages for [Fable website](http://fable.io) using several resources, among them:
This project generates the static web pages for [Fable website](http://fable.io). Requirements are the same as for other Fable projects (plus [yarn](https://yarnpkg.com/)).

- [Markdown docs in Fable repo](https://github.com/fable-compiler/Fable/tree/master/docs)
- React components built with [Fable.React](https://github.com/fable-compiler/fable-react)
- [Handlebars templates](http://handlebarsjs.com/)
The F# project in `src` is compiled to a node app using Fable and then executed to generate the static pages. To run the app in development mode (with live reload of the server whenever F# sources change) run the following commands.

The F# project in `src` is compiled to a node app using Fable and then executed to generate the static pages. To run app the app in development mode (with live reload of the server whenever F# sources change) run the following commands.

> Requirements are the same as for other Fable projects. [yarn](https://yarnpkg.com/) is used as the JS package manager.
> TL;DR Run `yarn` to install dependencies, `yarn start-all` for development and `yarn deploy` to update the site.
Install JS and F# dependencies (only first time or whenever dependencies change):

Expand Down Expand Up @@ -45,7 +41,7 @@ Alternatively, you can run the following to run the three processes (Fable, serv
yarn start-all
```

## Build and publish to Github pages
## Render the pages and publish them to Github

Run `yarn deploy` (this assumes you already compiled the F# project).

Expand Down
5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@
"postinstall": "dotnet restore src",
"server": "reload -b --dir public",
"sass": "node-sass files/styles.sass public/css/bulma.custom.css",
"start-all": "concurrently -k \"cd src && dotnet fable fable-splitter -- -w\" \"yarn server\" \"yarn sass -w\"",
"build-all": "concurrently \"cd src && dotnet fable-splitter\" \"yarn sass\"",
"sass-watch": "yarn sass && yarn sass -w",
"start-all": "concurrently -k \"cd src && dotnet fable fable-splitter -- -w\" \"yarn server\" \"yarn sass-watch\"",
"build-all": "concurrently \"cd src && dotnet fable fable-splitter\" \"yarn sass\"",
"predeploy": "yarn sass && node build/Main.js",
"deploy": "gh-pages -d public -b master"
},
Expand Down
Loading

0 comments on commit e234caf

Please sign in to comment.