{"id":26064649,"url":"https://github.com/mage-os/devdocs-website","last_synced_at":"2025-10-06T03:53:19.174Z","repository":{"id":284377360,"uuid":"657055692","full_name":"mage-os/devdocs-website","owner":"mage-os","description":"Mage-OS devdocs website","archived":false,"fork":false,"pushed_at":"2025-08-11T10:20:02.000Z","size":73205,"stargazers_count":3,"open_issues_count":5,"forks_count":12,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-10-03T12:36:53.342Z","etag":null,"topics":["adobecommerce","documentation","ecommerce","mage-os","magento2"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mage-os.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-06-22T08:10:37.000Z","updated_at":"2025-08-11T10:20:07.000Z","dependencies_parsed_at":null,"dependency_job_id":"6ef5c8f7-a847-4bd4-829a-3e4afc32a839","html_url":"https://github.com/mage-os/devdocs-website","commit_stats":null,"previous_names":["mage-os/devdocs-website"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/mage-os/devdocs-website","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mage-os%2Fdevdocs-website","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mage-os%2Fdevdocs-website/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mage-os%2Fdevdocs-website/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mage-os%2Fdevdocs-website/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mage-os","download_url":"https://codeload.github.com/mage-os/devdocs-website/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mage-os%2Fdevdocs-website/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278556190,"owners_count":26006081,"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","status":"online","status_checked_at":"2025-10-06T02:00:05.630Z","response_time":65,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["adobecommerce","documentation","ecommerce","mage-os","magento2"],"created_at":"2025-03-08T18:42:23.457Z","updated_at":"2025-10-06T03:53:19.152Z","avatar_url":"https://github.com/mage-os.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Mage-OS DevDocs Website\n\nThis is the source of the official [Mage-OS DevDocs Website](https://devdocs.mage-os.org).\n\n## Contribute to the Documentation\n\nIf you want to curate, edit, add or change content on the documentation, please go\nto [the Mage-OS DevdDocs Repository](https://github.com/mage-os/devdocs).\n\n## Local Development\nThe website is build with Laravel. **A database is not required**. You can run the website locally with the following\ncommands:\n\n```bash\ngit clone git@github.com:mage-os/devdocs-website.git devdocs-website\ncd devdocs-website\nbash bin/setup.sh\n```\n\nNext, you need to compile the assets and start the server:\n\n```bash\nnpm run dev\nphp artisan serve\n```\n\nNow add the documentation itself;\n\n```\nbash bin/checkout_latest_docs.sh\n```\n\nThere is no container based setup. There are plenty of different setups out there, so we leave it up to you to choose\nyour favorite one. If you want a docker-based setup, [Laravel's Sail](https://laravel.com/docs/10.x/sail) might be an \noption for you. \n\n### Torchlight Integration\n\nThis project relies on Torchlight for syntax highlighting. You will need to create an account\nat [torchlight.dev](https://torchlight.dev/) and generate a free personal token for use in this project. If you used \nthe `bin/setup.sh` script to setup the project, the token is in your .env file. If not, add the following line to your\n.env file manually:\n\n```ini\nTORCHLIGHT_TOKEN=your-torchlight-token\n```\n\n### Syncing Upstream Changes Into Your Fork\n\nThis [GitHub article](https://help.github.com/en/articles/syncing-a-fork) provides instructions on how to pull the\nlatest changes from this repository into your fork.\n\n### Updating After Remote Code Changes\n\nIf you pull down the upstream changes from this repository into your local repository, you'll want to update your\nComposer and NPM dependencies, as well as update your documentation branches. For convenience, you may run\nthe `bin/update.sh` script to update these things:\n\n```bash\n./bin/update.sh\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmage-os%2Fdevdocs-website","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmage-os%2Fdevdocs-website","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmage-os%2Fdevdocs-website/lists"}