{"id":21030317,"url":"https://github.com/fuse-open/docs","last_synced_at":"2025-05-15T11:32:30.886Z","repository":{"id":35586748,"uuid":"131993216","full_name":"fuse-open/docs","owner":"fuse-open","description":"Fuse documentation","archived":false,"fork":false,"pushed_at":"2024-06-18T17:16:57.000Z","size":312883,"stargazers_count":12,"open_issues_count":0,"forks_count":16,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-05-07T08:45:07.582Z","etag":null,"topics":["documentation","fuse","markdown","uno","ux","website"],"latest_commit_sha":null,"homepage":"https://fuseopen.com/docs","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fuse-open.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":null,"patreon":null,"open_collective":"fuse-open","ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2018-05-03T12:40:28.000Z","updated_at":"2024-06-18T17:17:19.000Z","dependencies_parsed_at":"2024-11-09T20:36:07.672Z","dependency_job_id":null,"html_url":"https://github.com/fuse-open/docs","commit_stats":{"total_commits":181,"total_committers":17,"mean_commits":"10.647058823529411","dds":0.5082872928176796,"last_synced_commit":"cc03fc999812a78c7fe39df984c522c6b9469903"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fuse-open%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fuse-open%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fuse-open%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fuse-open%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fuse-open","download_url":"https://codeload.github.com/fuse-open/docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253611672,"owners_count":21935941,"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":["documentation","fuse","markdown","uno","ux","website"],"created_at":"2024-11-19T12:17:36.533Z","updated_at":"2025-05-15T11:32:25.841Z","avatar_url":"https://github.com/fuse-open.png","language":"C#","funding_links":["https://opencollective.com/fuse-open"],"categories":[],"sub_categories":[],"readme":"# Fuse Documentation\n\n[![Build Status](https://travis-ci.com/fuse-open/docs.svg?branch=master)](https://travis-ci.com/fuse-open/docs)\n[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/fuse-open/docs/pulls)\n\nThis is the source code for the documentation for Fuse, as hosted [here](https://fuseopen.com/docs).\n\nThe documentation is hosted on GitHub Pages, from the [gh-pages branch](https://github.com/fuse-open/docs/tree/gh-pages). This branch gets automatically updated by a Travis CI build-step.\n\n## Running locally\n\n```shell\nnpm install\nnpm start\n```\n\nThis will build HTML pages based on documentation files, start a webserver at http://localhost:8080/, and finally open your default browser at this URL.\n\nThis will also watch your source files and rebuild HTML pages automatically while you're making changes.\nJust save in your editor and refresh in your browser (give it a second or three). 🙂\n\nSome system dependencies are required to process files. On macOS they can be installed by running the following command.\n\n```shell\nbrew install imagemagick pngquant optipng\n```\n\n\u003e On Windows image processing is disabled so there we don't need to install the dependencies, but [Git for Windows](https://github.com/git-for-windows/git/releases) is nice to have for running scripts.\n\n\u003e For more details about build commands see [build.sh](build.sh).\n\n### Fast Mode™\n\nWhen building locally using `npm start`, Fast Mode™ is enabled by\ndefault for the ability to test and iterate quickly. 🚀\n\nIn Fast Mode™ we skip processing `api-docs/`, images, and take a few\nshortcuts -- so the resulting HTML pages are not complete, missing\nUno/UX reference pages and related links. Most things are still fine.\n\nIf you need to test a complete build, run this command instead.\n\n```shell\nnpm run start-slow\n```\n\n\u003e Rebuilding HTML pages automatically while making changes only works in Fast Mode™.\n\n### Other commands\n\nType this to see all commands that are available.\n\n```shell\nnpm run\n```\n\n## Updating API docs\n\n```shell\nnpm run api-docs\n```\n\n1. Run `npm install` to install dependencies.\n2. *Optional:* Run `npm install -D fuse-sdk` to upgrade to latest versions of Fuse SDK modules.\n    * Or, if you wish specific versions you can do that. Just install the versions of `@fuse-open/fuselibs` and/or `@fuse-open/uno` that you want.\n    * Or, install a custom artifact, e.g. `https://ci.appveyor.com/api/buildjobs/wqgf7r6oiiwb16ff/artifacts/fuse-open-fuselibs-2.0.0.tgz`. You can find build artifacts on our AppVeyor pages for Uno and Fuselibs.\n    * Or, install another module for adding to our API references.\n    * Or, use `npm link` for any local modules you're working on.\n    * Run `npm outdated` to see if anything is out of date.\n3. Run `npm run api-docs` to update files in `api-docs/`, based on modules installed in step 2.\n4. Run `npm run start-slow` to build new HTML pages, presented at http://localhost:8080/.\n5. *Optional:* Open a [Pull Request](https://github.com/fuse-open/docs/pulls) if you did something good. :)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffuse-open%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffuse-open%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffuse-open%2Fdocs/lists"}