Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fsprojects/FSharp.Formatting
F# tools for generating documentation (Markdown processor and F# code formatter)
https://github.com/fsprojects/FSharp.Formatting
Last synced: 11 days ago
JSON representation
F# tools for generating documentation (Markdown processor and F# code formatter)
- Host: GitHub
- URL: https://github.com/fsprojects/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 (7 months ago)
- Last Synced: 2024-05-02T01:53:53.659Z (7 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
README
fsdocs and FSharp.Formatting 
=================================
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)