You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
You can install Fornax via the [Homebrew](http://brew.sh) package manager on OS X
31
-
32
-
brew tap Krzysztof-Cieslak/fornax && brew install fornax
33
-
34
-
#### Via Linuxbrew (Linux)
35
-
36
-
You can install Fornax via the [Linuxbrew](http://linuxbrew.sh/) package manager on Linux
37
-
38
-
brew tap Krzysztof-Cieslak/fornax && brew install fornax
39
-
40
-
#### Other
41
-
42
-
You can download one of the releases found at https://gitlab.com/Krzysztof-Cieslak/Fornax/tags
43
-
44
-
Alternately you can clone the repo, build the source, and then move the files in your bin folder to a location of your choosing.
21
+
Fornax is released as a global .Net Core tool. You can install it with `dotnet tool install fornax -g`
45
22
46
23
## CLI Application
47
24
48
25
The main functionality of Fornax comes from CLI applications that lets user scaffold, and generate webpages.
49
26
50
27
*`fornax new` - scaffolds new blog in current working directory using really simple template
51
28
*`fornax build` - builds webpage, puts output to `_public` folder
52
-
*`fornax watch` - starts small webserver that host your blog post, and background process that recompiles blog whenver any changes are detected. That's suggested way of working with Fornax
29
+
*`fornax watch` - starts small webserver that host your blog post, and background process that recompiles blog whenever any changes are detected. That's suggested way of working with Fornax
53
30
*`fornax clean` - removes output directory and any temp files.
54
31
*`fornax version` - prints out version of Fornax
55
32
*`fornax help` - prints out help
@@ -79,7 +56,7 @@ SomeGlobalValue: "Test global value"
79
56
80
57
### Templates
81
58
82
-
Templates are F# script files representing different templates that can be used in the website. They need to `#load``siteModel.fsx` file, and `#r``Fornax.Core.dll`. They need to define F# record called `Model` which defines additional settings passed to this particular template, and `generate` function of following signature: `SiteModel -> Model -> Post list -> string -> HtmlElement`. `SiteModel` is type representing global settings of webpage, `Model` is type representing settings for this template, `Post list` contains simplifed information about all avaliable posts in the blog (usefull for navigation, creating tag cloud etc.) `string` is main content of post (already compiled to `html`).
59
+
Templates are F# script files representing different templates that can be used in the website. They need to `#load``siteModel.fsx` file, and `#r``Fornax.Core.dll`. They need to define F# record called `Model` which defines additional settings passed to this particular template, and `generate` function of following signature: `SiteModel -> Model -> Post list -> string -> HtmlElement`. `SiteModel` is type representing global settings of webpage, `Model` is type representing settings for this template, `Post list` contains simplified information about all available posts in the blog (useful for navigation, creating tag cloud etc.) `string` is main content of post (already compiled to `html`).
83
60
84
61
Templates are defined using DSL defined in `Html` module of `Fornax.Core`.
85
62
@@ -110,7 +87,7 @@ let generate (siteModel : SiteModel) (mdl : Model) (posts: Post list) (content :
110
87
111
88
### Page content
112
89
113
-
Content files are `.md` files containg page contnt, and header with settings (defined using yaml). Header part is parsed, and passed to template `generate` function as `Model`. Content part is compiled to html and also passed to `generate` function. Header part needs to have `layout` entry which defines which template will be used for the page.
90
+
Content files are `.md` files containing page content, and header with settings (defined using yaml). Header part is parsed, and passed to template `generate` function as `Model`. Content part is compiled to html and also passed to `generate` function. Header part needs to have `layout` entry which defines which template will be used for the page.
114
91
115
92
Sample page:
116
93
@@ -145,7 +122,7 @@ It's filled based on respective entries in `layout` part of the post content fil
145
122
146
123
1. Hmmm... it looks similar to Jekyll, doesn't it?
147
124
148
-
* Yes, indeed. But the main advantage over Jekyll is type safe DSL for defining templates, and fact it's using normal prorgramming language - no additional syntax to things like loops or conditional statements, it's also very easy to compose templates - you just `#load` other template and execute as normal F# function
125
+
* Yes, indeed. But the main advantage over Jekyll is type safe DSL for defining templates, and fact it's using normal programming language - no additional syntax to things like loops or conditional statements, it's also very easy to compose templates - you just `#load` other template and execute as normal F# function
149
126
150
127
2. What about F# Formatting?
151
128
@@ -159,7 +136,7 @@ There might be a little voice inside that tells you you're not ready; that you n
159
136
160
137
I assure you, that's not the case.
161
138
162
-
This project has some clear Contribution Guidelines and expectations that you can [read here](https://github.com/Krzysztof-Cieslak/Saturn/blob/master/CONTRIBUTING.md).
139
+
This project has some clear Contribution Guidelines and expectations that you can [read here](https://github.com/LambdaFactory/Saturn/blob/master/CONTRIBUTING.md).
163
140
164
141
The contribution guidelines outline the process that you'll need to follow to get a patch merged. By making expectations and process explicit, I hope it will make it easier for you to contribute.
165
142
@@ -169,7 +146,7 @@ Thank you for contributing!
169
146
170
147
## Contributing and copyright
171
148
172
-
The project is hosted on [GitHub](https://github.com/Krzysztof-Cieslak/Fornax) where you can [report issues](https://github.com/Krzysztof-Cieslak/Fornax/issues), fork
173
-
the project and submit pull requests. Please read [Contribution Guide](https://github.com/Krzysztof-Cieslak/Fornax/blob/master/CONTRIBUTING.md)
149
+
The project is hosted on [GitHub](https://github.com/LambdaFactory/Fornax) where you can [report issues](https://github.com/LambdaFactory/Fornax/issues), fork
150
+
the project and submit pull requests. Please read [Contribution Guide](https://github.com/LambdaFactory/Fornax/blob/master/CONTRIBUTING.md)
174
151
175
-
The library is available under [MIT license](https://github.com/Krzysztof-Cieslak/Fornax/blob/master/LICENSE.md), which allows modification and redistribution for both commercial and non-commercial purposes.
152
+
The library is available under [MIT license](https://github.com/LambdaFactory/Fornax/blob/master/LICENSE.md), which allows modification and redistribution for both commercial and non-commercial purposes.
0 commit comments