{"id":13398047,"url":"https://github.com/outline/outline","last_synced_at":"2026-10-18T21:11:47.648Z","repository":{"id":37310510,"uuid":"59435364","full_name":"outline/outline","owner":"outline","description":"The fastest knowledge base for growing teams. Beautiful, realtime collaborative, feature packed, and markdown compatible.","archived":false,"fork":false,"pushed_at":"2026-10-08T02:35:49.000Z","size":334475,"stargazers_count":40842,"open_issues_count":83,"forks_count":3606,"subscribers_count":185,"default_branch":"main","last_synced_at":"2026-10-08T17:41:16.863Z","etag":null,"topics":["docker","javascript","mobx","nodejs","react","slack","wiki"],"latest_commit_sha":null,"homepage":"https://www.getoutline.com","language":"TypeScript","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/outline.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"docs/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"docs/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","claude":null,"gemini":null,"cursor":null,"copilot":null,"dco":null,"cla":null,"disclosure":null},"funding":{"github":["outline"]}},"created_at":"2016-05-22T21:31:47.000Z","updated_at":"2026-10-08T14:08:49.000Z","dependencies_parsed_at":"2026-09-22T02:20:09.024Z","dependency_job_id":null,"html_url":"https://github.com/outline/outline","commit_stats":{"total_commits":6472,"total_committers":187,"mean_commits":34.6096256684492,"dds":0.3682014833127317,"last_synced_commit":"6bb798220ba0353991d9e449bb47152346bf8d85"},"previous_names":[],"tags_count":253,"template":false,"template_full_name":null,"purl":"pkg:github/outline/outline","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outline%2Foutline","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outline%2Foutline/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outline%2Foutline/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outline%2Foutline/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/outline","download_url":"https://codeload.github.com/outline/outline/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outline%2Foutline/sbom","scorecard":{"id":174960,"data":{"date":"2025-08-04","repo":{"name":"github.com/outline/outline","commit":"4822261187d0bb95df9797115212e596c7b27d3d"},"scorecard":{"version":"v5.2.1-28-gc1d103a9","commit":"c1d103a9bb9f635ec7260bf9aa0699466fa4be0e"},"score":6.1,"checks":[{"name":"Code-Review","score":7,"reason":"Found 20/28 approved changesets -- score normalized to 7","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#code-review"}},{"name":"Maintained","score":10,"reason":"30 commit(s) and 13 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#maintained"}},{"name":"Security-Policy","score":10,"reason":"security policy file detected","details":["Info: security policy file detected: docs/SECURITY.md:1","Info: Found linked content: docs/SECURITY.md:1","Info: Found disclosure, vulnerability, and/or timelines in security policy: docs/SECURITY.md:1","Info: Found text in security policy: docs/SECURITY.md:1"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#security-policy"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: jobLevel 'contents' permission set to 'write': .github/workflows/calibreapp-image-actions.yml:31","Info: jobLevel 'actions' permission set to 'read': .github/workflows/codeql-analysis.yml:28","Info: jobLevel 'contents' permission set to 'read': .github/workflows/codeql-analysis.yml:29","Warn: jobLevel 'contents' permission set to 'write': .github/workflows/lint.yml:16","Warn: no topLevel permission defined: .github/workflows/auto_close_prs.yml:1","Info: found token with 'none' permissions: .github/workflows/calibreapp-image-actions.yml:1","Warn: no topLevel permission defined: .github/workflows/ci.yml:1","Warn: no topLevel permission defined: .github/workflows/codeql-analysis.yml:1","Warn: no topLevel permission defined: .github/workflows/docker.yml:1","Warn: no topLevel permission defined: .github/workflows/lint.yml:1"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#cii-best-practices"}},{"name":"License","score":9,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Warn: project license file does not contain an FSF or OSI license."],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#license"}},{"name":"Packaging","score":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/docker.yml:13"],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#packaging"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#signed-releases"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#binary-artifacts"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#branch-protection"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/auto_close_prs.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/auto_close_prs.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/calibreapp-image-actions.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/calibreapp-image-actions.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/calibreapp-image-actions.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/calibreapp-image-actions.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/calibreapp-image-actions.yml:56: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/calibreapp-image-actions.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:128: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:129: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:145: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:146: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/ci.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:155: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:54: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:55: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:69: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/ci.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:70: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:96: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:97: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/codeql-analysis.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/codeql-analysis.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:56: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/codeql-analysis.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:70: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/codeql-analysis.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docker.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/docker.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/docker.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/docker.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/docker.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/docker.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker.yml:54: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/docker.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker.yml:64: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/docker.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docker.yml:85: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/docker.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docker.yml:96: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/docker.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker.yml:99: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/docker.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker.yml:103: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/docker.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker.yml:112: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/docker.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker.yml:119: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/docker.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker.yml:133: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/docker.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker.yml:143: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/docker.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docker.yml:164: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/docker.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docker.yml:178: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/docker.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker.yml:185: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/docker.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker.yml:191: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/docker.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker.yml:195: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/docker.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/lint.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/lint.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/lint.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/lint.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/stale.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/outline/outline/stale.yml/main?enable=pin","Warn: containerImage not pinned by hash: Dockerfile:3","Warn: containerImage not pinned by hash: Dockerfile:9","Warn: containerImage not pinned by hash: Dockerfile.base:2","Info:   0 out of  27 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of  20 third-party GitHubAction dependencies pinned","Info:   0 out of   3 containerImage dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#pinned-dependencies"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#fuzzing"}},{"name":"SAST","score":10,"reason":"SAST tool is run on all commits","details":["Info: SAST configuration detected: CodeQL","Info: all commits (28) are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"12 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-67mh-4wv8-2f99","Warn: Project is vulnerable to: GHSA-75v8-2h7p-7m2m","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j","Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-g3ch-rx76-35fx","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-16T17:28:59.262Z","repository_id":37310510,"created_at":"2025-08-16T17:28:59.263Z","updated_at":"2025-08-16T17:28:59.263Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":344872684,"owners_count":38341851,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-10-03T21:59:58.778Z","status":"online","status_checked_at":"2026-10-18T02:00:06.448Z","response_time":63,"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":["docker","javascript","mobx","nodejs","react","slack","wiki"],"created_at":"2024-07-30T18:02:03.807Z","updated_at":"2026-10-18T21:11:47.642Z","avatar_url":"https://github.com/outline.png","language":"TypeScript","funding_links":["https://github.com/sponsors/outline"],"categories":["JavaScript","TypeScript","Apps","Communication and Collaboration Tools","Top","开发运维工具","By Industry","Knowledge Center / Wiki","HarmonyOS","Systems","docker","语言资源库","Productivity","Application Recommendation","wiki","By Language","react","User Interface","Productivity \u0026 Notes","💻 IDE \u0026 Automation","工具","LLM Wiki Tools","Table of Contents","Media automation (\\*arr stack)","Open Source","🌐 Web Development - Frontend","Web 应用","Web Frontend","Wikis and Team Knowledge Bases"],"sub_categories":["KnowledgeBase","Version Control, Wiki, Knowledge base","DevOps","Follow me","Windows Manager","typescript","📝 Document Collaboration","TypeScript","Applications and End User Tools","Business \u0026 Enterprise","调试","Knowledge Base","Web UI","React \u0026 UI Libraries"],"readme":"\u003cp align=\"center\"\u003e\n  \u003cpicture\u003e\n    \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"./public/logos/outline-logo-dark.png\" height=\"29\"\u003e\n    \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"./public/logos/outline-logo-light.png\" height=\"29\"\u003e\n    \u003cimg src=\"./public/logos/outline-logo-light.png\" height=\"29\" alt=\"Outline\" /\u003e\n  \u003c/picture\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003ci\u003eA fast, collaborative, knowledge base for your team built using React and Node.js.\u003cbr/\u003eTry out Outline using our hosted version at \u003ca href=\"https://www.getoutline.com\"\u003ewww.getoutline.com\u003c/a\u003e.\u003c/i\u003e\n  \u003cbr/\u003e\n  \u003cimg width=\"1640\" alt=\"screenshot\" src=\"https://user-images.githubusercontent.com/380914/110356468-26374600-7fef-11eb-9f6a-f2cc2c8c6590.png\"\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"http://www.typescriptlang.org\" rel=\"nofollow\"\u003e\u003cimg src=\"https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg\" alt=\"TypeScript\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/styled-components/styled-components\"\u003e\u003cimg src=\"https://img.shields.io/badge/style-%F0%9F%92%85%20styled--components-orange.svg\" alt=\"Styled Components\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://translate.getoutline.com/project/outline\" alt=\"Localized\"\u003e\u003cimg src=\"https://badges.crowdin.net/outline/localized.svg\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\nThis is the source code that runs [**Outline**](https://www.getoutline.com) and all the associated services. If you want to use Outline then you don't need to run this code, A hosted version of the app is offered at [getoutline.com](https://www.getoutline.com). You can also find documentation on using Outline in [our guide](https://docs.getoutline.com/s/guide).\n\nIf you'd like to run your own copy of Outline or contribute to development then this is the place for you.\n\n# Installation\n\nPlease see the [documentation](https://docs.getoutline.com/s/hosting/) for running your own copy of Outline in a production configuration.\n\nAvailable container images:\n* [![Container Image Release](https://img.shields.io/docker/v/outlinewiki/outline?sort=semver\u0026label=Latest%20release)](https://hub.docker.com/r/outlinewiki/outline)\n* [![Container Image Nightly](https://img.shields.io/docker/v/outlinewiki/outline?sort=date\u0026label=Latest%20development%20version)](https://hub.docker.com/r/outlinewiki/outline)\n\nIf you have questions or improvements for the docs please create a thread in [GitHub discussions](https://github.com/outline/outline/discussions).\n\n# Contributing\n\n\u003e **Note:** Please do not submit AI-generated pull requests. We receive a high volume of mass, low-quality PRs generated by AI tools like Claude, ChatGPT, and Copilot from contributors who are unfamiliar with the codebase. These PRs are almost never mergeable and waste maintainer time reviewing them. If you’d like to contribute, please take the time to understand the codebase and write your changes thoughtfully.\n\nBefore submitting a pull request _you must_ discuss with the core team by creating or commenting in an issue on [GitHub](https://www.github.com/outline/outline/issues) – we’d also love to hear from you in the [discussions](https://www.github.com/outline/outline/discussions). This way we can ensure that an approach is agreed on before code is written and that you have read these instructions. This will result in a much higher likelihood of your code being accepted.\n\nIf you’re looking for ways to get started, here’s a list of ways to help us improve Outline:\n\n- [Translation](docs/TRANSLATION.md) into other languages\n- Issues with [`good first issue`](https://github.com/outline/outline/labels/good%20first%20issue) label\n- Performance improvements, both on server and frontend\n- Developer happiness and documentation\n- Bugs, quality fixes, and other issues listed on GitHub\n\n# Development\n\nThere is a short guide for [setting up a development environment](https://docs.getoutline.com/s/hosting/doc/local-development-5hEhFRXow7) if you wish to contribute changes, fixes, and improvements to Outline.\n\n## Architecture\n\nIf you're interested in contributing or learning more about the Outline codebase\nplease refer to the [architecture document](docs/ARCHITECTURE.md) first for a high level overview of how the application is put together.\n\n## Debugging\n\nIn development Outline outputs simple logging to the console, prefixed by categories. In production it outputs JSON logs, these can be easily parsed by your preferred log ingestion pipeline.\n\nHTTP logging is disabled by default, but can be enabled by setting the `DEBUG=http` environment variable. logging\ncan be enabled for all categories by setting `DEBUG=*` or for specific categories such as `DEBUG=database` and `LOG_LEVEL=debug`, or `LOG_LEVEL=silly` for very verbose logging.\n\n## Tests\n\nWe aim to have sufficient test coverage for critical parts of the application and aren't aiming for 100% unit test coverage. All API endpoints and anything authentication related should be thoroughly tested.\n\nTo add new tests, write your tests with [Vitest](https://vitest.dev/) and add a file with `.test.ts` extension next to the tested code.\n\n```shell\n# To run all tests\nmake test\n\n# To run backend tests in watch mode\nmake watch\n```\n\nOnce the test database is created with `make test` you may individually run\nfrontend and backend tests directly with vitest:\n\n```shell\n# To run backend tests\nyarn test:server\n\n# To run a specific backend test in watch mode\nyarn test path/to/file.test.ts --watch\n\n# To run frontend tests\nyarn test:app\n```\n\n## Migrations\n\nSequelize is used to create and run migrations, for example:\n\n```shell\nyarn db:create-migration --name my-migration\nyarn db:migrate\nyarn db:rollback\n```\n\nOr, to run migrations on test database:\n\n```shell\nyarn db:migrate --env test\n```\n\n# Activity\n\n![Alt](https://repobeats.axiom.co/api/embed/ff2e4e6918afff1acf9deb72d1ba6b071d586178.svg \"Repobeats analytics image\")\n\n# License\n\nOutline is [BSL 1.1 licensed](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foutline%2Foutline","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foutline%2Foutline","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foutline%2Foutline/lists"}