{"id":19584979,"url":"https://github.com/forem/forem-docs","last_synced_at":"2025-04-27T11:33:12.882Z","repository":{"id":38213850,"uuid":"366769816","full_name":"forem/forem-docs","owner":"forem","description":null,"archived":false,"fork":false,"pushed_at":"2024-03-26T13:56:08.000Z","size":10880,"stargazers_count":27,"open_issues_count":2,"forks_count":40,"subscribers_count":9,"default_branch":"main","last_synced_at":"2024-03-26T14:54:13.414Z","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/forem.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/contributing-guide/_category_.json","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2021-05-12T15:50:29.000Z","updated_at":"2024-03-16T07:52:44.000Z","dependencies_parsed_at":"2023-09-22T22:58:13.353Z","dependency_job_id":"3f64c873-677e-4077-a52d-6a1080139f2a","html_url":"https://github.com/forem/forem-docs","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/forem%2Fforem-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/forem%2Fforem-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/forem%2Fforem-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/forem%2Fforem-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/forem","download_url":"https://codeload.github.com/forem/forem-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224069554,"owners_count":17250454,"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-11T07:51:59.683Z","updated_at":"2024-11-11T07:52:00.682Z","avatar_url":"https://github.com/forem.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Forem Developer Docs\n\nWelcome to Forem's developer documentation! The docs are built using [Docusaurus 2](https://docusaurus.io/), a React and Markdown based documentation website generator.\n\nOur developer docs are meant to be used as a way to find instructions to setup a local instance of Forem, documentation on the architecture of Forem, how to contribute, and many other useful documents.\n\nIf you have launched a Forem community of your own and are looking for documentation on how to manage that community, please see our [Admin Docs](https://admin.forem.com/)\n\n## Technical Overview\n\nMost of the configuration here is not too different from the basic `preset-classic` of Docusaurus. The main folders are:\n- `docs`: where the documentation lives\n- `src`: any custom CSS, components or pages\n- `static/img`: any image files\n\n## Installation\n\n```console\ngit clone https://github.com/forem/forem-docs.git\nyarn install\n```\n\n## Local Development\n\nOnce installed:\n\n```console\nyarn 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\nAll relevant Markdown files are in `docs/`. To update any docs, simply update the Markdown file with your favorite Markdown editor.\nYou can also add new files to the relevant sections.\n\nFor other types of contributions outside of text changes to Markdown files, please see [Docusaurus' docs](https://docusaurus.io/docs) for additional info.\n\n## Search\n\nOn production, search is run by [Algolia](https://www.algolia.com), specifically their [DocSearch service](https://docsearch.algolia.com/).\nThe service scrapes the website every 24 hours or so, so new contributions to the docs may take about that long to update.\n\n## Testing Production Builds\n\nTo see if your changes will build (for ex. you made added some screenshots) you can run:\n\n```console\nyarn build\n```\n\nAlternatively, you can make a pull request and use the corresponding deploy preview that builds.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fforem%2Fforem-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fforem%2Fforem-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fforem%2Fforem-docs/lists"}