Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md #2267

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+65 −64
Open

Update README.md #2267

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
129 changes: 65 additions & 64 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,87 +1,88 @@
<p align="center">
<a href="https://strapi.io">
<img src="./docusaurus/static/img/logo.png" width="314px" alt="Strapi logo" />
</a>
</p>
<h3 align="center">API creation made simple, secure and fast.</h3>
<p align="center">The most advanced open-source headless CMS to build powerful APIs with no effort.</p>
<br />
<p align="center"> <a href="https://strapi.io"> <img src="./docusaurus/static/img/logo.png" width="314px" alt="Strapi logo" /> </a> </p> <h3 align="center">API Creation Made Simple, Secure, and Fast</h3> <p align="center">Strapi: The most advanced open-source headless CMS for building powerful APIs with minimal effort.</p>
Introduction to Strapi
Strapi is a headless CMS (Content Management System), which means it allows developers to manage and deliver content across different platforms, such as websites, mobile apps, or other digital devices, without being tied to a specific frontend.

---
Think of Strapi as a tool to:

If you are looking for the Strapi code, please see the [Strapi Monorepo](https://github.com/strapi/strapi). The present repository is only for the official Strapi documentation hosted at [docs.strapi.io](https://docs.strapi.io). Blog articles hosted at [strapi.io/blog](https://strapi.io/blog) and [community content](https://github.com/strapi/community-content) are not covered by the present repository either.
Store content (like articles, products, or user data).
Customize APIs (so other apps or websites can use this content).
Control how and where this content is delivered (websites, apps, or even chatbots).
Why Use Strapi?
Control Over Data

---
With Strapi, you are in charge of where and how your data is stored. You don't need to rely on third-party services—you can host your data wherever you want.
Flexible Hosting Options

Strapi is a free and open-source headless CMS that delivers your content anywhere you need.
You can host your Strapi project on any platform:
Cloud platforms like AWS or Heroku
Static hosting services like Netlify
Your own server or VPS (Virtual Private Server)
Database Freedom

- **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.
Strapi works with multiple databases like PostgreSQL, MySQL, MariaDB, or SQLite, allowing you to choose the one you’re comfortable with or already using.
Highly Customizable

## Documentation websites
Strapi gives you complete control over how your APIs work. You can modify routes, plugins, and functionality to match your project’s needs.
How to Use Strapi Documentation
Strapi has different documentation websites, each serving a specific purpose:

The main official Strapi documentation website is hosted at [docs.strapi.io](https://docs.strapi.io).
Main Documentation:
docs.strapi.io – The most up-to-date documentation for Strapi’s latest version.

Additional official Strapi documentation websites cover different content:
Older Versions:

- Documentation for the older version 4 of Strapi is hosted at [docs-v4.strapi.io](https://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](https://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](https://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](https://contributor.strapi.io). This experimental documentation is maintained by Strapi engineers and any issue should be reported to the [`strapi/strapi`](https://github.com/strapi/strapi/issues/new/choose) repository.
- Documentation for the Strapi Design System is hosted at [design-system.strapi.io](https://design-system.strapi.io/) and maintained by Strapi front-end engineers in its [dedicated repository](https://github.com/strapi/design-system/).
Version 4 – Community-maintained; no new updates from the Strapi team.
Version 3 – Legacy documentation for users still working with older versions.
Upcoming Changes:
docs-next.strapi.io – Preview the latest updates and experimental features (coming in late 2024).

## Contribution requirements
Contributor Documentation:
contributor.strapi.io – Learn how to contribute code or improvements to Strapi.

The following are required if you are submitting pull requests to the documentation:
Design System Documentation:
design-system.strapi.io – Covers front-end design components used within Strapi.

- NodeJS >=16.14 <=18.x.x
- NPM >= 6.x
- Yarn >= 1.22.x
How to Contribute to Strapi Documentation
We welcome contributions! If you want to help improve Strapi’s documentation, here’s what you’ll need:

👉 For more information on how to contribute, please read our [contribution guide](./CONTRIBUTING.md).
Node.js: Version 16.14 or newer (up to 18.x.x).
NPM: 6.x or later (NPM is a package manager for JavaScript).
Yarn: 1.22.x or higher (an alternative package manager to NPM).
Steps to Contribute:
Fork the repository and make your changes.
Follow our contribution guide to submit a pull request.
Reporting Documentation Issues
If you find mistakes in the documentation (such as broken screenshots, wrong instructions, or incorrect code samples), you can help us by reporting them:

## Issues
Verify the issue is related to the documentation, not the product itself (e.g., missing product features should be reported to the main repository).
Report Issues: Use the documentation issue template.
For product-related issues, please report them at Strapi’s main repository.

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](https://github.com/strapi/documentation/issues/new?template=BUG_REPORT.yml) template to report them. To submit an issue:
Where to Get Help
If you run into challenges or need further assistance, here are several ways to get help:

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](https://github.com/strapi/strapi) repository. Updates to blog posts found at [strapi.io/blog](https://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](https://strapi.io/contact) 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:
Community Forum: forum.strapi.io – Ask questions, share ideas, and discuss solutions.
Discord: discord.strapi.io – Engage with other users and developers in real-time.
GitHub: github.com/strapi/strapi – Report product bugs or contribute to the codebase.
Feature Requests: strapi.canny.io – Suggest new features or improvements.
Video Tutorials: YouTube Channel – Watch step-by-step guides and learn from experts.
Requesting New Documentation
We encourage users to request new content or suggest improvements to existing documentation.

- Open a Q&A thread on our [official forum](https://forum.strapi.io).
- Engage with other community members on our [community Discord server](https://discord.strapi.io).
Use the documentation request template to make a request. The Strapi Documentation team will review and prioritize requests for future updates.

## Requests
Documentation Updates and Release Schedule
Strapi documentation follows a continuous delivery model, meaning updates can happen multiple times a day. Each Wednesday, a weekly release is published, summarizing all recent changes. You can view the latest release notes here.

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](https://github.com/strapi/documentation/issues/new?template=DOC_REQUEST.md&title%5B%5D=REQUEST) 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.
Code of Conduct
Strapi believes in fostering a positive and inclusive community. All participants must adhere to the Strapi Code of Conduct.

## Releases
Versioning System
Starting with Strapi 5, the documentation version is no longer synchronized with the product version. The documentation is now treated as a separate product and follows its own versioning system.

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](https://github.com/strapi/documentation/releases) happen on Wednesdays and include a list of changes since the latest release.
Summary
Strapi is an open-source headless CMS that offers developers the freedom to build and customize APIs, choose their hosting environment, and manage their data independently. It provides excellent documentation and an active community to support developers of all levels.

## Community support
If you’re new to Strapi or want to dive deeper, explore the official documentation or connect with other users through the community forum or Discord.

For general help using Strapi, please refer to [the official Strapi documentation](https://strapi.io/documentation/). For additional help, you can use one of these channels to ask a question:

- [Discord](http://discord.strapi.io) (For live discussion with the Community and Strapi team)
- [Primary GitHub](https://github.com/strapi/strapi) (Bug reports, Contributions)
- [Community Forum](https://forum.strapi.io) (Questions and Discussions)
- [Canny](https://strapi.canny.io/) (Roadmap, Feature requests)
- [Twitter](https://twitter.com/strapijs) (Get the news fast)
- [Facebook](https://www.facebook.com/Strapi-616063331867161)
- [YouTube Channel](https://www.youtube.com/strapi) (Learn from Video Tutorials)

## License

See the [LICENSE](./LICENSE) file for licensing information.

## Code of Conduct

This project and everyone participating in it are governed by the [Strapi Code of Conduct](CODE_OF_CONDUCT.md). 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.
This version provides clear explanations of technical terms, makes navigation easier, and ensures that users of all levels can understand the content effortlessly.