Skip to content

Latest commit

 

History

History
87 lines (56 loc) · 6.36 KB

README.md

File metadata and controls

87 lines (56 loc) · 6.36 KB
Raw

Strapi logo

API creation made simple, secure and fast.

The most advanced open-source headless CMS to build powerful APIs with no effort.


If you are looking for the Strapi code, please see the Strapi Monorepo. The present repository is only for the official Strapi documentation hosted at docs.strapi.io. Blog articles hosted at strapi.io/blog and community content are not covered by the present repository either.

Strapi is a free and open-source headless CMS that delivers your content anywhere you need.

  • Keep control over your data. With Strapi, you know where your data is stored, and you keep full control at all times.
  • Self-hosted. You can host and scale Strapi projects the way you want. You can choose any hosting platform you want: AWS, Netlify, Heroku, a VPS, or a dedicated server. You can scale as you grow, 100% independent.
  • Database agnostic. You can choose the database you prefer. Strapi works with SQL databases: PostgreSQL, MySQL, MariaDB, and SQLite.
  • Customizable. You can quickly build your logic by fully customizing APIs, routes, or plugins to fit your needs perfectly.

Documentation websites

The main official Strapi documentation website is hosted at docs.strapi.io.

Additional official Strapi documentation websites cover different content:

  • Documentation for the older version 4 of Strapi is hosted at docs-v4.strapi.io and featured in the v4 branch. This branch is not actively maintained by the Strapi Documentation team, but community contributions are most welcome!
  • Upcoming, experimental documentation is hosted at docs-next.strapi.io. Starting autumn/winter 2024, this website will include an all-new documentation — more info soon!
  • Documentation for the older, unsupported version 3 of Strapi is hosted at docs-v3.strapi.io.
  • Documentation for contributors, which include more in-depth and experimental content for developers who actively maintain and contribute to Strapi, is hosted at contributor.strapi.io. This experimental documentation is maintained by Strapi engineers and any issue should be reported to the strapi/strapi repository.
  • Documentation for the Strapi Design System is hosted at design-system.strapi.io and maintained by Strapi front-end engineers in its dedicated repository.

Contribution requirements

The following are required if you are submitting pull requests to the documentation:

  • NodeJS >=16.14 <=18.x.x
  • NPM >= 6.x
  • Yarn >= 1.22.x

👉 For more information on how to contribute, please read our contribution guide.

Issues

Submitting issues help to improve the documentation. If you find incorrect screenshot(s), instructions, or code examples, or if you discover UX/UI bugs on the website, please use our documentation issue template to report them. To submit an issue:

  1. Verify the issue is only with one of the Strapi documentation websites. Product-related issues, missing Strapi features, and any issues not directly related to the documentation should be directed at the main strapi/strapi repository. Updates to blog posts found at strapi.io/blog are also outside the scope of the present documentation repository; you can either reach the author of the blog post directly or use the contact form on Strapi's corporate website if you have questions about blog posts.
  2. Follow the issue template and fill out as much information as you can.

Technical questions should be asked using the following resources:

Requests

Requests for new documentation are highly encouraged. This is not limited to new additions but also changes or more information requested on existing documentation. Please use our request documentation issue template. These requests will be checked by the Strapi Documentation team then transferred to another internal tool outside GitHub for priorization and subsequent actions.

Releases

Thanks to a continuous integration/continuous delivery workflow, the Strapi documentation can be updated up to several times a day, depending on the number and frequency of contributions. Weekly snapshot releases happen on Wednesdays and include a list of changes since the latest release.

Community support

For general help using Strapi, please refer to the official Strapi documentation. For additional help, you can use one of these channels to ask a question:

License

See the LICENSE file for licensing information.

Code of Conduct

This project and everyone participating in it are governed by the Strapi Code of Conduct. By participating, you are expected to uphold the code.

Package version

Please note that, starting with Strapi 5, strapi/documentation and strapi/strapi package version numbers are not synchronized any more. Strapi Docs are treated as their own product and will follow their own numbering system.