{"id":18265145,"url":"https://github.com/nasa-ammos/slim-docsite-template","last_synced_at":"2025-04-09T01:42:41.982Z","repository":{"id":243939681,"uuid":"813822288","full_name":"NASA-AMMOS/slim-docsite-template","owner":"NASA-AMMOS","description":"Software product website template to demonstrate best practices around an open source software products website/","archived":false,"fork":false,"pushed_at":"2025-04-08T00:31:01.000Z","size":2860,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-08T01:23:02.536Z","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":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NASA-AMMOS.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":"GOVERNANCE.md","roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-06-11T20:09:02.000Z","updated_at":"2025-04-08T00:31:05.000Z","dependencies_parsed_at":"2024-12-22T15:23:54.191Z","dependency_job_id":"32bfbadb-4305-4154-bc26-22f7c4b02d03","html_url":"https://github.com/NASA-AMMOS/slim-docsite-template","commit_stats":null,"previous_names":["nasa-ammos/slim-docsite-template"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NASA-AMMOS%2Fslim-docsite-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NASA-AMMOS%2Fslim-docsite-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NASA-AMMOS%2Fslim-docsite-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NASA-AMMOS%2Fslim-docsite-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NASA-AMMOS","download_url":"https://codeload.github.com/NASA-AMMOS/slim-docsite-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247958710,"owners_count":21024821,"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":"2024-11-05T11:17:14.716Z","updated_at":"2025-04-09T01:42:41.950Z","avatar_url":"https://github.com/NASA-AMMOS.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- Header block for project --\u003e\n\u003chr\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n\u003c!-- ☝️ Replace with your logo (if applicable) via ![](https://uri-to-your-logo-image) ☝️ --\u003e\n\u003c!-- ☝️ If you see logo rendering errors, make sure you're not using indentation, or try an HTML IMG tag --\u003e\n\n\u003ch1 align=\"center\"\u003e[INSERT PROJECT NAME] Website\u003c/h1\u003e\n\u003c!-- ☝️ Replace with your repo name ☝️ --\u003e\n\n\u003c/div\u003e\n\n\u003cpre align=\"center\"\u003eWebsite and Docs for [INSERT PROJECT NAME].\u003c/pre\u003e\n\u003c!-- ☝️ Replace with a single sentence describing the purpose of your repo / proj ☝️ --\u003e\n\n\u003c!-- Header block for project --\u003e\n\n[INSERT YOUR BADGES HERE (SEE: https://shields.io)] [![SLIM](https://img.shields.io/badge/Best%20Practices%20from-SLIM-blue)](https://nasa-ammos.github.io/slim/)\n\u003c!-- ☝️ Add badges via: https://shields.io e.g. ![](https://img.shields.io/github/your_chosen_action/your_org/your_repo) ☝️ --\u003e\n\n[INSERT SCREENSHOT OF YOUR SOFTWARE, IF APPLICABLE]\n\u003c!-- ☝️ Screenshot of your software (if applicable) via ![](https://uri-to-your-screenshot) ☝️ --\u003e\n\n[INSERT PROJECT NAME] hosts a website built with Docusaurus, a site generator that is optimized for building documentation websites. It was created to help you quickly and easily set up a website for your project, including comprehensive documentation and other static content.\n\n[INSERT LIST OF IMPORTANT PROJECT / REPO LINKS HERE]\n\u003c!-- example links\u003e\n[Website](INSERT WEBSITE LINK HERE) | [Docs/Wiki](INSERT DOCS/WIKI SITE LINK HERE) | [Discussion Board](INSERT DISCUSSION BOARD LINK HERE) | [Issue Tracker](INSERT ISSUE TRACKER LINK HERE)\n--\u003e\n\n## Features\n\n* Simple and efficient setup with Docusaurus\n* Live-reloading development server for quick feedback\n* Easy deployment to GitHub Pages\n* Customizable to fit your project’s branding and needs\n  \n\u003c!-- ☝️ Replace with a bullet-point list of your features ☝️ --\u003e\n\n## Contents\n\n- [Features](#features)\n- [Contents](#contents)\n- [Quick Start](#quick-start)\n  - [Requirements](#requirements)\n  - [Setup Instructions](#setup-instructions)\n  - [Run Instructions](#run-instructions)\n  - [Build Instructions](#build-instructions)\n  - [Deployment](#deployment)\n- [Changelog](#changelog)\n- [Frequently Asked Questions (FAQ)](#frequently-asked-questions-faq)\n- [Contributing](#contributing)\n- [License](#license)\n- [Support](#support)\n\n## Quick Start\n\nThis guide provides a quick way to get started with our project. Please see our [docs]([INSERT LINK TO DOCS SITE / WIKI HERE]) for a more comprehensive overview.\n\n### Requirements\n\n* Node.js and npm installed on your machine\n* Yarn package manager\n\n\u003c!-- ☝️ Replace with a numbered list of your requirements, including hardware if applicable ☝️ --\u003e\n\n### Setup Instructions\n\n1. Clone the repository to your local machine.\n2. Install the dependencies:\n  ```\n  yarn\n  ```\n\n\u003c!-- ☝️ Replace with a numbered list of how to set up your software prior to running ☝️ --\u003e\n\n### Run Instructions\n\n1. Start the local development server:\n  ```\n  yarn start\n  ```\n\nThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.\n\n\u003c!-- ☝️ Replace with a numbered list of your run instructions, including expected results ☝️ --\u003e\n\n### Build Instructions\n\n1. Build the static content:\n  ```\n  yarn build\n  ```\n\nThis command generates static content into the `build` directory and can be served using any static content hosting service.\n\n\u003c!-- ☝️ Replace with a numbered list of your build instructions, including expected results / outputs with optional screenshots ☝️ --\u003e\n\n### Deployment\n\nThe project is configured to automatically build and deploy using GitHub Actions. The workflow files located within the `.github/workflows` directory are set up to trigger builds whenever commits are pushed to the `main` branch. Additionally, pull requests will be automatically built for testing purposes.\n\nTo ensure your site is properly deployed:\n\n1. Ensure that GitHub Pages is enabled for your repository. You can enable it by going to the repository settings on GitHub and selecting the branch you want to use for GitHub Pages, typically `gh-pages` or `main`.\n   \n2. If you prefer manual deployment or are not using GitHub Actions, you can still deploy manually:\n\n   - Deploy using SSH:\n     ```\n     USE_SSH=true yarn deploy\n     ```\n\n   - Deploy without SSH:\n     ```\n     GIT_USER=\u003cYour GitHub username\u003e yarn deploy\n     ```\n\n3. For more detailed information on deploying with GitHub Actions, please refer to the [Docusaurus documentation](https://docusaurus.io/docs/deployment#triggering-deployment-with-github-actions).\n\nBy following these steps, your site will be automatically built and deployed when changes are made to the `main` branch or when pull requests are created. Manual deployment commands are also available if needed.\n\n## Changelog\n\nSee our [CHANGELOG.md](CHANGELOG.md) for a history of our changes.\n\nSee our [releases page]([INSERT LINK TO YOUR RELEASES PAGE]) for our key versioned releases.\n\n\u003c!-- ☝️ Replace with links to your changelog and releases page ☝️ --\u003e\n\n## Frequently Asked Questions (FAQ)\n\n[INSERT LINK TO FAQ PAGE OR PROVIDE FAQ INLINE HERE]\n\u003c!-- example link to FAQ PAGE\u003e\nQuestions about our project? Please see our: [FAQ]([INSERT LINK TO FAQ / DISCUSSION BOARD])\n--\u003e\n\n\u003c!-- example FAQ inline format\u003e\n1. Question 1\n- Answer to question 1\n2. Question 2\n- Answer to question 2\n--\u003e\n\n\u003c!-- example FAQ inline with no questions yet\u003e\nNo questions yet. Propose a question to be added here by reaching out to our contributors! See support section below.\n--\u003e\n\n\u003c!-- ☝️ Replace with a list of frequently asked questions from your project, or post a link to your FAQ on a discussion board ☝️ --\u003e\n\n## Contributing\n\n[INSERT LINK TO CONTRIBUTING GUIDE OR FILL INLINE HERE]\n\u003c!-- example link to CONTRIBUTING.md\u003e\nInterested in contributing to our project? Please see our: [CONTRIBUTING.md](CONTRIBUTING.md)\n--\u003e\n\n\u003c!-- example inline contributing guide\u003e\n1. Create an GitHub issue ticket describing what changes you need (e.g. issue-1)\n2. [Fork](INSERT LINK TO YOUR REPO FORK PAGE HERE, e.g. https://github.com/my_org/my_repo/fork) this repo\n3. Make your modifications in your own fork\n4. Make a pull-request in this repo with the code in your fork and tag the repo owner / largest contributor as a reviewer\n\n**Working on your first pull request?** See guide: [How to Contribute to an Open Source [INSERT PROJECT NAME] on GitHub](https://kcd.im/pull-request)\n--\u003e\n\n[INSERT LINK TO YOUR CODE_OF_CONDUCT.md OR SHARE TEXT HERE]\n\u003c!-- example link to CODE_OF_CONDUCT.md\u003e\nFor guidance on how to interact with our team, please see our code of conduct located at: [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)\n--\u003e\n\n\u003c!-- ☝️ Replace with a text describing how people may contribute to your project, or link to your contribution guide directly ☝️ --\u003e\n\n[INSERT LINK TO YOUR GOVERNANCE.md OR SHARE TEXT HERE]\n\u003c!-- example link to GOVERNANCE.md\u003e\nFor guidance on our governance approach, including decision-making process and our various roles, please see our governance model at: [GOVERNANCE.md](GOVERNANCE.md)\n--\u003e\n\n## License\n\nSee our: [LICENSE](LICENSE)\n\u003c!-- ☝️ Replace with the text of your copyright and license, or directly link to your license file ☝️ --\u003e\n\n## Support\n\n[INSERT CONTACT INFORMATION OR PROFILE LINKS TO MAINTAINERS AMONG COMMITTER LIST]\n\n\u003c!-- example list of contacts\u003e\nKey points of contact are: [@github-user-1](link to github profile) [@github-user-2](link to github profile)\n--\u003e\n\n\u003c!-- ☝️ Replace with the key individuals who should be contacted for questions ☝️ --\u003e\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnasa-ammos%2Fslim-docsite-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnasa-ammos%2Fslim-docsite-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnasa-ammos%2Fslim-docsite-template/lists"}