https://fsprojects.github.io/FSharp.Formatting/

F# tools for generating documentation (Markdown processor and F# code formatter)
https://fsprojects.github.io/FSharp.Formatting/

Last synced: about 2 months ago
JSON representation

F# tools for generating documentation (Markdown processor and F# code formatter)

• Host: GitHub
• URL: https://fsprojects.github.io/FSharp.Formatting/
• Owner: fsprojects
• License: other
• Created: 2012-01-17T13:41:05.000Z (almost 13 years ago)
• Default Branch: main
• Last Pushed: 2024-04-15T11:47:29.000Z (8 months ago)
• Last Synced: 2024-05-02T01:53:53.659Z (8 months ago)
• Language: F#
• Homepage: https://fsprojects.github.io/FSharp.Formatting/
• Size: 18.7 MB
• Stars: 458
• Watchers: 36
• Forks: 153
• Open Issues: 72
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-csharp - F# Formatting - Tools for documenting F# and C# projects from F# script files, Markdown documents and inline XML or Markdown comments (Documentation)
• awesome-dotnet-cn - F# Formatting - F#和C#项目的文档工具，文档生成自F#脚本文件、Markdown文档、内嵌XML或 Markdown评论。 (文档)
• awesome-dotnet - F# Formatting - Tools for documenting F# and C# projects from F# script files, Markdown documents and inline XML or Markdown comments (Documentation)
• awesome-dot-dev - F# Formatting - Tools for documenting F# and C# projects from F# script files, Markdown documents and inline XML or Markdown comments (Documentation)
• awsome-dotnet - F# Formatting - Tools for documenting F# and C# projects from F# script files, Markdown documents and inline XML or Markdown comments (Documentation)
• awesome-dotnet - F# Formatting - Tools for documenting F# and C# projects from F# script files, Markdown documents and inline XML or Markdown comments (Documentation)

README

        
fsdocs and FSharp.Formatting ![Build and Test](https://github.com/fsprojects/FSharp.Formatting/actions/workflows/push-main.yml/badge.svg)

=================================

The FSharp.Formatting package includes libraries and tools for processing F# script files, markdown and components

for documentation generation. The primary tool is "fsdocs".

See https://fsprojects.github.io/FSharp.Formatting/

## Development

    dotnet fsi build.fsx

Once built, you can run the command-line tool to self-build the docs for this directory using 

    dotnet build

    src\fsdocs-tool\bin\Debug\net6.0\fsdocs.exe watch

    src\fsdocs-tool\bin\Debug\net6.0\fsdocs.exe build --clean

### Pipelines

Run

    dotnet fsi build.fsx -- --help

to see what other pipelines can be run from `build.fsx`.

    dotnet fsi build.fsx -- -p Verify

Will perform the linting, unit tests and analyzer check.

This is useful to run locally before submitting your PR.

## Maintainer(s)

- [@dsyme](https://github.com/dsyme)

- [@baronfel](https://github.com/baronfel)

- [@nhirschey](https://github.com/nhirschey)

- [@nojaf](https://github.com/nojaf)