{"id":13398047,"url":"https://github.com/outline/outline","last_synced_at":"2026-04-01T17:57:32.519Z","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":"2025-05-08T15:58:36.000Z","size":69194,"stargazers_count":31974,"open_issues_count":128,"forks_count":2573,"subscribers_count":173,"default_branch":"main","last_synced_at":"2025-05-08T16:49:41.212Z","etag":null,"topics":["docker","hacktoberfest","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},"funding":{"github":["outline"]}},"created_at":"2016-05-22T21:31:47.000Z","updated_at":"2025-05-08T16:16:15.000Z","dependencies_parsed_at":"2023-10-15T09:05:55.669Z","dependency_job_id":"6d28158a-b82c-4584-b96b-804a637f8d7f","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":211,"template":false,"template_full_name":null,"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","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253668946,"owners_count":21945055,"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":["docker","hacktoberfest","javascript","mobx","nodejs","react","slack","wiki"],"created_at":"2024-07-30T18:02:03.807Z","updated_at":"2026-04-01T17:57:32.504Z","avatar_url":"https://github.com/outline.png","language":"TypeScript","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/prettier/prettier\"\u003e\u003cimg src=\"https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat\" alt=\"Prettier\"\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\nIf you have questions or improvements for the docs please create a thread in [GitHub discussions](https://github.com/outline/outline/discussions).\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## Contributing\n\nOutline is built and maintained by a small team – your help finding and fixing bugs is appreciated, though AI assisted PR's from new contributors are discouraged and unlikely to be merged.\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 and other issues listed on GitHub\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 [Jest](https://facebook.github.io/jest/) 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 jest:\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","funding_links":["https://github.com/sponsors/outline"],"categories":["JavaScript","TypeScript","Apps","Communication and Collaboration Tools","Top","开发运维工具","By Industry","Knowledge Center / Wiki","Table of Contents","HarmonyOS","知识管理 wiki知识库","Systems","docker","语言资源库","Productivity","Application Recommendation","wiki","By Language","react","工具","Productivity \u0026 Notes","Open Source"],"sub_categories":["KnowledgeBase","Version Control, Wiki, Knowledge base","DevOps","Follow me","Knowledge Base","Windows Manager","网络服务_其他","typescript","📝 Document Collaboration","TypeScript","调试","Web UI"],"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"}