{"id":24807350,"url":"https://github.com/openframeproject/openframe-docs","last_synced_at":"2026-02-09T22:32:30.991Z","repository":{"id":19387785,"uuid":"79735983","full_name":"OpenframeProject/Openframe-Docs","owner":"OpenframeProject","description":"Documentation for Openframe","archived":false,"fork":false,"pushed_at":"2022-10-20T07:15:45.000Z","size":465,"stargazers_count":3,"open_issues_count":9,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-06T06:51:16.624Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/OpenframeProject.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-01-22T18:21:56.000Z","updated_at":"2023-11-24T18:31:11.000Z","dependencies_parsed_at":"2022-09-04T22:11:25.906Z","dependency_job_id":null,"html_url":"https://github.com/OpenframeProject/Openframe-Docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/OpenframeProject/Openframe-Docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenframeProject%2FOpenframe-Docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenframeProject%2FOpenframe-Docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenframeProject%2FOpenframe-Docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenframeProject%2FOpenframe-Docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OpenframeProject","download_url":"https://codeload.github.com/OpenframeProject/Openframe-Docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenframeProject%2FOpenframe-Docs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261238882,"owners_count":23128876,"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":[],"created_at":"2025-01-30T09:18:24.354Z","updated_at":"2026-02-09T22:32:30.985Z","avatar_url":"https://github.com/OpenframeProject.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Documentation for Openframe\n\n## How To Contribute\n\nPlease help improving these docs. Feel free to [add an issue](https://github.com/OpenframeProject/Openframe-Docs/issues) or [create a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests).\n\nAll content is located in `source/index.html.md` and other files in `source/includes/`.\n\n## Development\n\nThese docs are based on [Slate](https://github.com/slatedocs/slate). Find more info in the [Slate Wiki](https://github.com/slatedocs/slate/wiki).\n\nFollow this guide to setup a development environment to verify your content updates or improve the website code:\n\n### 0. Prerequisites\n\nMake sure to meet Slate's prerequisites (Ruby, …): https://github.com/slatedocs/slate#prerequisites\n\n### 1. Install\n\n`bundle install`\n\nThis installs Slate's dependencies.\n\n### 2. Run development server\n\n`npm start`\n\nThis starts a preview web-server (http://localhost:4567). Use this to verify your changes. \n\nMore info (https://middlemanapp.com/basics/development-cycle/#middleman-server): \n\u003e You can create and edit files in the `source` folder and see the changes reflected on the preview web-server.\n\u003e You can stop the preview server from the command-line using `Ctrl + C`.\n\n### 3. Share your changes\n\nOnce you're done, commit your work and [create a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests). A maintainer of the project is going to review and deploy your changes.\n\n## Deploy\n\n`npm run deploy`\n\nThis builds the docs, creates a commit with the content of the `build` folder on the `gh-pages` branch. The changes are then (around a minute later) available at https://docs.openframe.io/. \n\n## Build\n\n`npm run build`\n\nThis compiles the docs into the `build` directory. ","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenframeproject%2Fopenframe-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenframeproject%2Fopenframe-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenframeproject%2Fopenframe-docs/lists"}