{"id":26121462,"url":"https://github.com/opensettings/open-settings-docs","last_synced_at":"2026-04-20T12:03:14.231Z","repository":{"id":281408580,"uuid":"940771386","full_name":"OpenSettings/open-settings-docs","owner":"OpenSettings","description":"Official documentation for OpenSettings – a centralized app settings management system for .NET applications.","archived":false,"fork":false,"pushed_at":"2025-03-08T21:25:01.000Z","size":1044,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-03-08T22:24:12.338Z","etag":null,"topics":["docfx","docs","dotnet","opensettings"],"latest_commit_sha":null,"homepage":"https://opensettings.net","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/OpenSettings.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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}},"created_at":"2025-02-28T19:02:00.000Z","updated_at":"2025-03-08T22:00:50.000Z","dependencies_parsed_at":"2025-03-08T22:25:09.794Z","dependency_job_id":"06e643ca-4287-4a47-b5e5-d18a731357cb","html_url":"https://github.com/OpenSettings/open-settings-docs","commit_stats":null,"previous_names":["opensettings/open-settings-docs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenSettings%2Fopen-settings-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenSettings%2Fopen-settings-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenSettings%2Fopen-settings-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenSettings%2Fopen-settings-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OpenSettings","download_url":"https://codeload.github.com/OpenSettings/open-settings-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242864790,"owners_count":20197779,"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":["docfx","docs","dotnet","opensettings"],"created_at":"2025-03-10T14:22:21.411Z","updated_at":"2026-04-20T12:03:14.211Z","avatar_url":"https://github.com/OpenSettings.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# \u003cimg src=\"logo/open-settings-logo.png\" alt=\"Header\" width=\"24\"/\u003e OpenSettings Docs\n\n[![Docs](https://img.shields.io/badge/docs-online-blue)](https://docs.opensettings.net)\n[![GitHub](https://img.shields.io/badge/•-open--settings-blue?logo=github)](https://github.com/OpenSettings/open-settings)\n\nWelcome to the official documentation repository for **OpenSettings**!\n\nOpenSettings is a **centralized settings management** system designed for **.NET applications**. It simplifies app settings management by providing a structured and scalable approach to handling settings.\n\n![Demo](https://github.com/OpenSettings/open-settings-docs/blob/master/docs/v1/assets/gifs/demo.gif)\n\n## 📖 Documentation\n\nThe latest OpenSettings documentation is available at [**docs.opensettings.net**](https://docs.opensettings.net)\n\n## 📂 Repository Structure\n\nThis repository contains all documentation files in **Markdown (`.md`) format**, and makes use of [DocFX](https://dotnet.github.io/docfx/) for generating static documentation.\n\n## 🚀 Getting Started\n\nTo contribute or run the documentation locally, follow these steps:\n\n### 1️⃣ Create Directory and Clone the Repository\n```sh\nmkdir OpenSettings\ngit clone https://github.com/OpenSettings/open-settings-docs.git\ncd OpenSettings/open-settings-docs/docs\n```\n\n### 2️⃣ Install DocFX  \nIf you don’t have **DocFX** installed, run:\n```sh\ndotnet tool install -g docfx\n```\n\n\u003e [!WARNING]\n\u003e PDF generation may require **Node.js**.  \n\u003e You can download it from: [https://nodejs.org/en/download](https://nodejs.org/en/download)  \n\nIf you don’t need PDF support, you can comment out or remove the following line from `./build.ps1`:\n\n```ps1\ndocfx pdf .\\v1\\docfx.json\n```\n\n### 3️⃣ Build and Serve Documentation Locally\n```sh\n./build.ps1\n```\n\nOpen your browser and navigate to **[http://localhost:8080](http://localhost:8080)** to preview the documentation! 🚀\n\n### 4️⃣ (Optional) Generate API Reference Files\n\nTo include API documentation:\n\n1. Clone the main OpenSettings repo into the same root folder:\n\n   ```sh\n   git clone https://github.com/OpenSettings/open-settings.git\n   ```\n\n2. Open `build.ps1` in a text editor and uncomment the following line by removing the `#`:\n\n   ```ps1\n   docfx metadata .\\v1\\docfx.json\n   ```\n\n3. Run the build script again:\n\n   ```sh\n   ./build.ps1\n   ```\n\n### 5️⃣ (Optional) Serve the Docs via .NET App\n\nWhen you run the `open-settings-docs/docs/build.ps1` script, it automatically generates the documentation and copies the `open-settings-docs/docs/_site` folder into:\n\n```\nopen-settings-docs/src/OpenSettings.Docs/wwwroot/\n```\n\nTo host it via a .NET application:\n\n1. Make sure you have the .NET SDK installed.\n2. Navigate to the app directory:\n\n   ```sh\n   open-settings-docs/src/OpenSettings.Docs\n   ```\n\n3. Run the app:\n\n   ```sh\n   dotnet run\n   ```\n\nThis will serve the generated documentation using the built-in .NET Core web server.\n\n```bash\ninfo: Microsoft.Hosting.Lifetime[14]\n      Now listening on: https://localhost:7186\ninfo: Microsoft.Hosting.Lifetime[14]\n      Now listening on: http://localhost:5184\n```\n\n## 💡 License  \n\nLicensed under the [OpenSettings License](https://opensettings.net/license).\n\n## 🤝 Contributing\n\nBy contributing this repository, you agree to the [Contribution Terms](https://opensettings.net/contribution-terms).\n\n## 🐞 Issues \u0026 Reports\n\nIf you encounter any issues or have suggestions, please report them via our GitHub repository.\n\n### How to Report an Issue:\n1. **Search for Existing Issues**: Check if your issue has already been reported in the [Issues section](https://github.com/OpenSettings/open-settings-docs/issues).\n2. **Submit a New Issue**: If not, create a new issue by clicking **\"New issue\"** on the [Issues page](https://github.com/OpenSettings/open-settings-docs/issues), describing the problem, and including relevant details like steps to reproduce, error messages, and logs.\n\n### Reporting Guidelines:\n- Be specific about the issue, including environment and configuration details.\n- Include relevant error logs or screenshots if available.\n\n### Security Concerns:\nFor security-related issues, **do not** use GitHub Issues. Contact us directly at [security@opensettings.net](mailto:security@opensettings.net).\n\nWe appreciate your feedback and will address your concerns as soon as possible!\n\n## 🔗 Useful Links\n\n- 🌍 **Website:** [opensettings.net](https://opensettings.net)\n- ❤️ **Become a Sponsor:** [opensettings.net/become-a-sponsor](https://opensettings.net/become-a-sponsor)\n- 📜 **License:** [opensettings.net/license](https://opensettings.net/license)\n- ⚖️ **Terms \u0026 Conditions:** [opensettings.net/terms-and-conditions](https://opensettings.net/terms-and-conditions)\n- 🔒 **Privacy Policy:** [opensettings.net/privacy-policy](https://opensettings.net/privacy-policy)\n\n\u003cbr\u003e\n\n✨ *OpenSettings makes settings management simple, powerful, and flexible!* 🚀\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopensettings%2Fopen-settings-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopensettings%2Fopen-settings-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopensettings%2Fopen-settings-docs/lists"}