https://github.com/fslaborg/docs-template

fslab documentation theme for FSharp.Formatting
https://github.com/fslaborg/docs-template

csharp documentation dotnet fsharp

Last synced: 3 months ago
JSON representation

fslab documentation theme for FSharp.Formatting

• Host: GitHub
• URL: https://github.com/fslaborg/docs-template
• Owner: fslaborg
• License: mit
• Created: 2021-01-05T16:37:32.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2023-11-17T14:37:08.000Z (about 1 year ago)
• Last Synced: 2024-04-14T01:34:07.013Z (10 months ago)
• Topics: csharp, documentation, dotnet, fsharp
• Language: F#
• Homepage: https://fslab.org/docs-template/
• Size: 805 KB
• Stars: 4
• Watchers: 6
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# The fslab documentation template

`dotnet new` template setting up the necessary folder structure and files for [FSharp.Formatting](https://github.com/fsprojects/FSharp.Formatting) documentation. It uses a custom fslab color scheme and html template.

## How does it look like?

The current version is live on gh-pages:

https://fslab.org/docs-template/

## Installation

[![](https://img.shields.io/nuget/v/FsLab.DocumentationTemplate)](https://www.nuget.org/packages/FsLab.DocumentationTemplate/)

```powershell

dotnet new -i FsLab.DocumentationTemplate

```

## Usage

If not already present, create a local tool manifest in the root of your project that you want to write documentation for:

```powershell

dotnet new tool-manifest

```

Then, still in the root of your project, run:

```powershell

dotnet new fslab-docs

```

for more more indepth information head over [here](https://fslab.org/docs-template/#Usage)

## Develop

To (re)compile with sass:

`build.cmd -t compileSass` (Win)

`build.sh -t compileSass` (Mac/Linux)

Build the template nuget package: 

`build.cmd` (Win)

`build.sh` (Mac/Linux)

Start fsdocs in watcher mode for the test project:

`build.cmd -t watchDocs` (Win)

`build.sh -t watchEDocs` (Mac/Linux)

Test the template package intallation and check correct contents of an initialized template:

`build.cmd -t test` (Win)

`build.sh -t test` (Mac/Linux)

will create the template output in the `tests` folder.

Release nuget package and create a tag on the repo:

`build.cmd -t release` (Win)

`build.sh -t release` (Mac/Linux)