{"id":20012122,"url":"https://github.com/fslaborg/docs-template","last_synced_at":"2025-05-04T20:31:23.983Z","repository":{"id":128317695,"uuid":"327058073","full_name":"fslaborg/docs-template","owner":"fslaborg","description":"fslab documentation theme for FSharp.Formatting","archived":false,"fork":false,"pushed_at":"2023-11-17T14:37:08.000Z","size":824,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-05-02T00:49:55.311Z","etag":null,"topics":["csharp","documentation","dotnet","fsharp"],"latest_commit_sha":null,"homepage":"https://fslab.org/docs-template/","language":"F#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fslaborg.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2021-01-05T16:37:32.000Z","updated_at":"2023-11-17T14:29:27.000Z","dependencies_parsed_at":null,"dependency_job_id":"1a04f1ee-aa83-42eb-9a3f-7639a07424bb","html_url":"https://github.com/fslaborg/docs-template","commit_stats":{"total_commits":66,"total_committers":1,"mean_commits":66.0,"dds":0.0,"last_synced_commit":"47f519871a43e2e0ede62fb3c7756729c78837c0"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fslaborg%2Fdocs-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fslaborg%2Fdocs-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fslaborg%2Fdocs-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fslaborg%2Fdocs-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fslaborg","download_url":"https://codeload.github.com/fslaborg/docs-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252395292,"owners_count":21741009,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["csharp","documentation","dotnet","fsharp"],"created_at":"2024-11-13T07:28:49.262Z","updated_at":"2025-05-04T20:31:23.963Z","avatar_url":"https://github.com/fslaborg.png","language":"F#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# The fslab documentation template\n\n`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.\n\n## How does it look like?\n\nThe current version is live on gh-pages:\n\nhttps://fslab.org/docs-template/\n\n\n## Installation\n\n[![](https://img.shields.io/nuget/v/FsLab.DocumentationTemplate)](https://www.nuget.org/packages/FsLab.DocumentationTemplate/)\n\n```powershell\ndotnet new -i FsLab.DocumentationTemplate\n```\n\n## Usage\n\nIf not already present, create a local tool manifest in the root of your project that you want to write documentation for:\n\n```powershell\ndotnet new tool-manifest\n```\n\nThen, still in the root of your project, run:\n\n```powershell\ndotnet new fslab-docs\n```\n\nfor more more indepth information head over [here](https://fslab.org/docs-template/#Usage)\n\n## Develop\n\nTo (re)compile with sass:\n\n`build.cmd -t compileSass` (Win)\n\n`build.sh -t compileSass` (Mac/Linux)\n\nBuild the template nuget package: \n\n`build.cmd` (Win)\n\n`build.sh` (Mac/Linux)\n\nStart fsdocs in watcher mode for the test project:\n\n`build.cmd -t watchDocs` (Win)\n\n`build.sh -t watchEDocs` (Mac/Linux)\n\nTest the template package intallation and check correct contents of an initialized template:\n\n`build.cmd -t test` (Win)\n\n`build.sh -t test` (Mac/Linux)\n\nwill create the template output in the `tests` folder.\n\nRelease nuget package and create a tag on the repo:\n\n`build.cmd -t release` (Win)\n\n`build.sh -t release` (Mac/Linux)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffslaborg%2Fdocs-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffslaborg%2Fdocs-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffslaborg%2Fdocs-template/lists"}