{"id":26032227,"url":"https://github.com/apache/nuttx-website","last_synced_at":"2025-04-09T17:35:12.339Z","repository":{"id":36795468,"uuid":"230303510","full_name":"apache/nuttx-website","owner":"apache","description":"Apache NuttX Website","archived":false,"fork":false,"pushed_at":"2025-04-03T00:29:11.000Z","size":398417,"stargazers_count":18,"open_issues_count":6,"forks_count":28,"subscribers_count":20,"default_branch":"master","last_synced_at":"2025-04-03T04:17:03.314Z","etag":null,"topics":["embedded","mcu","microcontroller","nuttx","real-time","rtos"],"latest_commit_sha":null,"homepage":"https://nuttx.apache.org/","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/apache.png","metadata":{"files":{"readme":"README.md","changelog":"history.md","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,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-12-26T17:37:13.000Z","updated_at":"2025-02-19T08:01:53.000Z","dependencies_parsed_at":"2024-02-10T01:26:55.380Z","dependency_job_id":"26071bd0-0343-4261-b920-0ce99f7f05f0","html_url":"https://github.com/apache/nuttx-website","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fnuttx-website","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fnuttx-website/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fnuttx-website/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fnuttx-website/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apache","download_url":"https://codeload.github.com/apache/nuttx-website/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247898950,"owners_count":21014808,"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":["embedded","mcu","microcontroller","nuttx","real-time","rtos"],"created_at":"2025-03-06T21:42:24.733Z","updated_at":"2025-04-09T17:35:11.785Z","avatar_url":"https://github.com/apache.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!--\n{% comment %}\nLicensed to the Apache Software Foundation (ASF) under one or more\ncontributor license agreements.  See the NOTICE file distributed with\nthis work for additional information regarding copyright ownership.\nThe ASF licenses this file to you under the Apache License, Version 2.0\n(the \"License\"); you may not use this file except in compliance with\nthe License.  You may obtain a copy of the License at\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n{% endcomment %}\n--\u003e\n\n# Apache NuttX RTOS Website\n\nSource code (written in [RubyGems](https://rubygems.org/))\nfor [our offical project's website](https://nuttx.apache.org)\nis stored here along with the build-and-publish automation scripts\n(using GitHub CI).\n\n[NuttX Technical Documentation](https://nuttx.apache.org/docs/latest/)\nis a sublocation of the project website, therefore is built and bundled here,\nbut documentation sources are part of the\n[NuttX source code repository](https://github.com/apache/nuttx/tree/master/Documentation)\nin order to stay in sync with the upstream code.\nDocumentation uses [Sphinx](https://www.sphinx-doc.org/) generator tools\nto produce HTML output.\n\nPlease keep in mind that Website (this repository) and Documentation (NuttX\nrepository) have different source origins and common resulting location.\n\n\n## Providing the Updates\n\nFork the repository, clone it to a local machine, make changes,\ncommit changes onto a dedicated branch, push the branch onto your\nfork repository, GitHub will help you create a Pull Request.\n\nRemember to use signed commits and report single problem per PR.\n\nMake sure to preview local changes before submitting a Pull Request.\n\nIf you already submitted a Pull Request, but some changes needs to be made,\nadd modified files with `git add \u003cyour_file\u003e`, then `git commit --amend`\nto update existing commit, then `git push -f \u003cyour_fork\u003e \u003cyour_branch\u003e`\nin order to update code under existing Pull Request.\n\n\n## Updating the Website\n\nWebsite source code resides at top location of this repository.\n\nBefore opening a Pull Request, you should preview your contributions.\n\nYou first need to install Ruby Gems on a local machine:\n\n```\nsudo apt install git ruby ruby-dev bundler\n```\n\nThen you can build and preview the results with:\n\n```\ngit clone https://github.com/apache/nuttx-website\ncd nuttx-website/\nexport GEM_HOME=$HOME/.gem       # Adjust this path as you want.\nexport PATH=$PATH:$GEM_HOME/bin  # Add Gem binaries to the path.\nbundle install                   # Install required packages.\nbundle exec jekyll serve         # Build and start local web server.\n```\n\nPreview should be visible at [http://localhost:4000](http://localhost:4000).\n\n**Note:** The `Gemfile.lock` may contain some platform specific pins.\nYou may want to regenerate it by deleting `Gemfile.lock`\nand running `bundle update`.  Pins can be locked\nfor `x86_64-linux`, `Darwin`, `FreeBSD`, and other build hosts with\n`bundle lock --add-platform \u003cyour_platform\u003e` command.\n\n\n## Updating the Documentaion\n\nNuttX Technical Documentation is part of the\n[NuttX source code repository](https://github.com/apache/nuttx/tree/master/Documentation).\n\nBefore opening a Pull Request, you should preview your contributions.\n\nYou first need to install Python3 and PipEnv.\n\n```\nsudo apt install git python3 pipenv\n```\n\nYou can setup build tools and create preview with:\n\n```\ngit clone https://github.com/apache/nuttx\ncd nuttx/Documentation\npipenv install\npipenv run make html\n```\n\nPreview files should be visible at `_build/html/` directory.\n\n\n## Website Publishing\n\nWebsite is updated by the GitHub CI Action script that builds the RubyGem\nand Shinx part from sources, bundles them together, and then runs the\n`publish.sh` script to update the web hosting at\n[https://nuttx.apache.org](https://nuttx.apache.org).\n\nWebsite build-and-publish Action can be started by hand with:\n1. [Actions](https://github.com/apache/nuttx-website/actions/workflows/main.yml).\n2. Run workflow.\n3. Branch: master.\n4. Run workflow.\n\n![Trigger Workflow](ci-workflow.png)\n\n\n## Important Locations\n\n* Apache NuttX RTOS Project Members, Mentors, PMC/IPMC members, and Committers\nare listed at\n[https://nuttx.apache.org/community-members/](https://nuttx.apache.org/community-members/).\n Source file for this site is located at [_data/contributors.yml](_data/contributors.yml).\n* Project details and link references are at [_data/project.yml](_data/project.yml).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapache%2Fnuttx-website","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapache%2Fnuttx-website","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapache%2Fnuttx-website/lists"}