https://github.com/fslaborg/fslab.fornax
Fornax components and template for fslab-themed websites
https://github.com/fslaborg/fslab.fornax
Last synced: 4 days ago
JSON representation
Fornax components and template for fslab-themed websites
- Host: GitHub
- URL: https://github.com/fslaborg/fslab.fornax
- Owner: fslaborg
- License: mit
- Created: 2023-02-28T10:37:15.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-26T12:39:34.000Z (over 2 years ago)
- Last Synced: 2024-04-14T01:39:09.475Z (about 2 years ago)
- Language: F#
- Homepage: http://fslab.org/FsLab.Fornax/
- Size: 500 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FsLab.Fornax
Fornax template for fslab websites
This repo contains the source for two packages:
- **FsLab.Fornax** [](https://www.nuget.org/packages/FsLab.Fornax/) is a library containing components for [fornax]() in the fslab style.
- FsLab.Fornax.Template [](https://www.nuget.org/packages/FsLab.Fornax.Template/) is a `dotnet new` template for instantly getting a fornax website in the fslab style up and running.
# Using the template
## install
`dotnet new install FsLab.Fornax.Template::*`
## cli usage
```
FsLab.Fornax.Template (F#)
Author: Kevin Schneider
Usage:
dotnet new fslab-web [options] [template options]
Options:
-n, --name The name for the output being created. If no name is specified, the name of the output
directory is used.
-o, --output Location to place the generated output.
--dry-run Displays a summary of what would happen if the given command line were run if it would result
in a template creation.
--force Forces content to be generated even if it would change existing files.
--no-update-check Disables checking for the template package updates when instantiating a template.
--project The project that should be used for context evaluation.
-lang, --language Specifies the template language to instantiate.
--type Specifies the template type to instantiate.
Template options:
-bu, --base-url The base url of the deployed site, will be used when building the static
htmls to prefix urls
Type: string
-st, --site-title The title of the site, will be used in page metadata
Type: string
-sd, --site-description The description of the site, will be used in page metadata
Type: string
```
## developing the website
In `/src` run
```
dotnet tool restore
dotnet fornax watch
```
## publishing the website
In `/src` run
```
dotnet fornax build
```
the output will be in the `_public` folder.