# AppFlowy Docs

## AppFlowy Docs

- [Start here](https://docs.appflowy.io/docs/appflowy/readme.md)
- [Welcome to AppFlowy Docs](https://docs.appflowy.io/docs/appflowy/readme/welcome-to-appflowy.md)
- [How to get help](https://docs.appflowy.io/docs/appflowy/readme/how-to-get-help.md)
- [Install AppFlowy](https://docs.appflowy.io/docs/appflowy/readme/install-appflowy.md)
- [Installation](https://docs.appflowy.io/docs/appflowy/install-appflowy.md)
- [System Requirements](https://docs.appflowy.io/docs/appflowy/install-appflowy/requirements.md): help-wanted
- [Installation methods](https://docs.appflowy.io/docs/appflowy/install-appflowy/installation-methods.md)
- [Mac / Windows / Linux Packages](https://docs.appflowy.io/docs/appflowy/install-appflowy/installation-methods/mac-windows-linux-packages.md): Download AppFlowy for Free 100% Open Source
- [Installing on Linux](https://docs.appflowy.io/docs/appflowy/install-appflowy/installation-methods/mac-windows-linux-packages/installing-on-linux.md)
- [Installing & Setting up Flutter on Linux from Source](https://docs.appflowy.io/docs/appflowy/install-appflowy/installation-methods/mac-windows-linux-packages/installing-on-linux/installing-and-setting-up-flutter-on-linux-from-source.md)
- [Docker](https://docs.appflowy.io/docs/appflowy/install-appflowy/installation-methods/installing-with-docker.md)
- [Community](https://docs.appflowy.io/docs/appflowy/community.md)
- [Get in contact](https://docs.appflowy.io/docs/appflowy/community/get-in-contact.md)
- [AppFlowy Mentorship Program](https://docs.appflowy.io/docs/appflowy/community/appflowy-mentorship-program.md)
- [Program Guidance](https://docs.appflowy.io/docs/appflowy/community/appflowy-mentorship-program/contributor-guidance.md)
- [Proposal Template](https://docs.appflowy.io/docs/appflowy/community/appflowy-mentorship-program/proposal-template.md)
- [Pull Request Template](https://docs.appflowy.io/docs/appflowy/community/appflowy-mentorship-program/pull-request-template.md)
- [Mentorship 2023](https://docs.appflowy.io/docs/appflowy/community/appflowy-mentorship-program/mentorship-2022.md)
- [Mentee Projects](https://docs.appflowy.io/docs/appflowy/community/appflowy-mentorship-program/mentorship-2022/mentee-projects.md)
- [Calendar View for AppFlowy Database](https://docs.appflowy.io/docs/appflowy/community/appflowy-mentorship-program/mentorship-2022/mentee-projects/calendar-view-for-appflowy-database.md): Richard Shiue
- [Custom Themes](https://docs.appflowy.io/docs/appflowy/community/appflowy-mentorship-program/mentorship-2022/mentee-projects/custom-themes.md): Chirag Bargoojar
- [Shortcuts and Customized Hotkeys for AppFlowy](https://docs.appflowy.io/docs/appflowy/community/appflowy-mentorship-program/mentorship-2022/mentee-projects/shortcuts-and-customized-hotkeys-for-appflowy.md): Mayur Mahajan
- [Table](https://docs.appflowy.io/docs/appflowy/community/appflowy-mentorship-program/mentorship-2022/mentee-projects/table.md): Mohammad Zolfaghari
- [Favorites](https://docs.appflowy.io/docs/appflowy/community/appflowy-mentorship-program/mentorship-2022/mentee-projects/favorites.md): Mihir Singh
- [Code Block](https://docs.appflowy.io/docs/appflowy/community/appflowy-mentorship-program/mentorship-2022/mentee-projects/code-block.md)
- [Outlines](https://docs.appflowy.io/docs/appflowy/community/appflowy-mentorship-program/mentorship-2022/mentee-projects/outlines.md): Aman Negi
- [Importers](https://docs.appflowy.io/docs/appflowy/community/appflowy-mentorship-program/mentorship-2022/mentee-projects/importers.md): Mukund Tandon
- [AI Writers](https://docs.appflowy.io/docs/appflowy/community/appflowy-mentorship-program/mentorship-2022/mentee-projects/ai-writers.md): Yatendra Kumar
- [Templates](https://docs.appflowy.io/docs/appflowy/community/appflowy-mentorship-program/mentorship-2022/mentee-projects/templates.md): Aman Negi
- [Project Ideas](https://docs.appflowy.io/docs/appflowy/community/appflowy-mentorship-program/mentorship-2022/project-ideas.md)
- [Write for AppFlowy](https://docs.appflowy.io/docs/appflowy/community/write-for-appflowy.md)
- [Drafts](https://docs.appflowy.io/docs/appflowy/community/write-for-appflowy/drafts.md)
- [\[Draft\] Use Case: Software Engineer](https://docs.appflowy.io/docs/appflowy/community/write-for-appflowy/drafts/draft-use-case-software-engineer.md)
- [\[Draft\] Use Case: High School Students](https://docs.appflowy.io/docs/appflowy/community/write-for-appflowy/drafts/draft-use-case-high-school-students.md)
- [\[Draft\] How to add a new property to appflowy database](https://docs.appflowy.io/docs/appflowy/community/write-for-appflowy/drafts/draft-how-to-add-a-new-property-to-appflowy-database.md)
- [Hacktoberfest](https://docs.appflowy.io/docs/appflowy/community/hacktoberfest.md)
- [Roadmap](https://docs.appflowy.io/docs/appflowy/roadmap.md)
- [Product](https://docs.appflowy.io/docs/appflowy/product.md)
- [Software Contributions](https://docs.appflowy.io/docs/documentation/software-contributions.md)
- [Get started](https://docs.appflowy.io/docs/documentation/software-contributions/contributing-to-appflowy.md)
- [Architecture](https://docs.appflowy.io/docs/documentation/software-contributions/architecture.md)
- [Frontend](https://docs.appflowy.io/docs/documentation/software-contributions/architecture/frontend.md)
- [Tauri](https://docs.appflowy.io/docs/documentation/software-contributions/architecture/frontend/frontend-tauri.md)
- [CodeMap](https://docs.appflowy.io/docs/documentation/software-contributions/architecture/frontend/frontend-tauri/codemap.md)
- [Web](https://docs.appflowy.io/docs/documentation/software-contributions/architecture/frontend/web.md)
- [Flutter](https://docs.appflowy.io/docs/documentation/software-contributions/architecture/frontend/frontend.md)
- [Project Structure: CodeMap](https://docs.appflowy.io/docs/documentation/software-contributions/architecture/frontend/frontend/codemap.md)
- [Grid](https://docs.appflowy.io/docs/documentation/software-contributions/architecture/frontend/frontend/grid.md)
- [Setting](https://docs.appflowy.io/docs/documentation/software-contributions/architecture/frontend/frontend/setting.md)
- [Inter-Process Communication](https://docs.appflowy.io/docs/documentation/software-contributions/architecture/frontend/inter-process-communication.md)
- [User](https://docs.appflowy.io/docs/documentation/software-contributions/architecture/frontend/user.md)
- [User Data](https://docs.appflowy.io/docs/documentation/software-contributions/architecture/frontend/user/user-data.md)
- [Events & Notifications](https://docs.appflowy.io/docs/documentation/software-contributions/architecture/frontend/user/events.md)
- [Folder](https://docs.appflowy.io/docs/documentation/software-contributions/architecture/frontend/folder.md)
- [Events & Notifications](https://docs.appflowy.io/docs/documentation/software-contributions/architecture/frontend/folder/events.md)
- [Document](https://docs.appflowy.io/docs/documentation/software-contributions/architecture/frontend/document.md)
- [Database View](https://docs.appflowy.io/docs/documentation/software-contributions/architecture/frontend/database-view.md)
- [Events & Notifications](https://docs.appflowy.io/docs/documentation/software-contributions/architecture/frontend/database-view/events.md)
- [Grid](https://docs.appflowy.io/docs/documentation/software-contributions/architecture/frontend/database-view/grid.md)
- [Calendar](https://docs.appflowy.io/docs/documentation/software-contributions/architecture/frontend/database-view/calendar.md): DISCLAIMER: This page contains information about features that are work-in-progress (WIP).
- [Kanban Board](https://docs.appflowy.io/docs/documentation/software-contributions/architecture/frontend/database-view/kanban-board.md): A kanban board is an project management tool designed to help visualize work, limit work-in-progress.
- [Backend](https://docs.appflowy.io/docs/documentation/software-contributions/architecture/backend.md)
- [Initialize](https://docs.appflowy.io/docs/documentation/software-contributions/architecture/backend/initialize.md)
- [Events](https://docs.appflowy.io/docs/documentation/software-contributions/architecture/backend/event.md)
- [Delta(WIP)](https://docs.appflowy.io/docs/documentation/software-contributions/architecture/backend/delta.md)
- [Profiling](https://docs.appflowy.io/docs/documentation/software-contributions/architecture/backend/profiling.md)
- [Database](https://docs.appflowy.io/docs/documentation/software-contributions/architecture/backend/database.md)
- [Domain Driven Design](https://docs.appflowy.io/docs/documentation/software-contributions/architecture/domain-driven-design.md)
- [Proposals](https://docs.appflowy.io/docs/documentation/software-contributions/architecture/proposals.md)
- [Conventions](https://docs.appflowy.io/docs/documentation/software-contributions/conventions.md)
- [Naming Conventions](https://docs.appflowy.io/docs/documentation/software-contributions/conventions/naming-conventions.md)
- [Code Conventions](https://docs.appflowy.io/docs/documentation/software-contributions/conventions/code-conventions.md)
- [Flutter](https://docs.appflowy.io/docs/documentation/software-contributions/conventions/code-conventions/flutter.md)
- [Git Conventions](https://docs.appflowy.io/docs/documentation/software-contributions/conventions/git-conventions.md)
- [Submitting Code](https://docs.appflowy.io/docs/documentation/software-contributions/submitting-code.md)
- [Setting Up Your Repositories](https://docs.appflowy.io/docs/documentation/software-contributions/submitting-code/setting-up-your-repositories.md)
- [Submitting your first Pull Request](https://docs.appflowy.io/docs/documentation/software-contributions/submitting-code/submitting-your-first-pull-request.md)
- [Coding Standards and Practices](https://docs.appflowy.io/docs/documentation/software-contributions/coding-standards-and-practices.md)
- [Rust Backend](https://docs.appflowy.io/docs/documentation/software-contributions/coding-standards-and-practices/rust-backend.md)
- [AppFlowy](https://docs.appflowy.io/docs/documentation/appflowy.md)
- [How to contribute to AppFlowy](https://docs.appflowy.io/docs/documentation/appflowy/draft-how-to-contribute-to-appflowy.md)
- [Building from Source](https://docs.appflowy.io/docs/documentation/appflowy/from-source.md)
- [Flutter Setup](https://docs.appflowy.io/docs/documentation/appflowy/from-source/environment-setup.md)
- [Building on Linux](https://docs.appflowy.io/docs/documentation/appflowy/from-source/environment-setup/building-on-linux.md)
- [Building on macOS](https://docs.appflowy.io/docs/documentation/appflowy/from-source/environment-setup/building-on-macos.md)
- [Building on Windows](https://docs.appflowy.io/docs/documentation/appflowy/from-source/environment-setup/building-on-windows.md)
- [Web Setup](https://docs.appflowy.io/docs/documentation/appflowy/from-source/web-setup.md)
- [Tauri Setup](https://docs.appflowy.io/docs/documentation/appflowy/from-source/tauri-setup.md)
- [Debugging with AppFlowy Cloud](https://docs.appflowy.io/docs/documentation/appflowy/debugging-with-appflowy-cloud.md)
- [Debugging in VS Code](https://docs.appflowy.io/docs/documentation/appflowy/launcher-and-tasks.md)
- [Translate AppFlowy](https://docs.appflowy.io/docs/documentation/appflowy/translation.md)
- [Troubleshooting](https://docs.appflowy.io/docs/documentation/appflowy/troubleshooting.md)
- [Licenses](https://docs.appflowy.io/docs/documentation/appflowy/licenses.md)
- [AppFlowy Editor](https://docs.appflowy.io/docs/documentation/appflowy-editor.md)
- [How to Implement Markdown Syntax To Style Text In AppFlowy Editor](https://docs.appflowy.io/docs/documentation/appflowy-editor/how-to-implement-markdown-syntax-to-style-text-in-appflowy-editor.md): Customizing hotkeys to format text
- [How to Create a Plugin for AppFlowy Editor](https://docs.appflowy.io/docs/documentation/appflowy-editor/how-to-create-a-plugin-for-appflowy-editor.md): https://pub.dev/packages/appflowy\_editor
- [Licenses](https://docs.appflowy.io/docs/documentation/appflowy-editor/licenses.md)
- [AppFlowy Cloud](https://docs.appflowy.io/docs/documentation/appflowy-cloud.md)
- [Architecture](https://docs.appflowy.io/docs/documentation/appflowy-cloud/architecture.md)
- [Deployment](https://docs.appflowy.io/docs/documentation/appflowy-cloud/deployment.md)
- [Self-Hosting AppFlowy](https://docs.appflowy.io/docs/guides/appflowy.md)
- [Import From Notion](https://docs.appflowy.io/docs/guides/import-from-notion.md)
- [Demystifying AppFlowy Editor's Codebase](https://docs.appflowy.io/docs/blog-highlights/demystifying-appflowy-editors-codebase.md): Understand what happens behind the scenes when you use the Editor, the folder structuring, and strategies you can implement for adding new features in the AppFlowy Editor package.
- [Core values](https://docs.appflowy.io/docs/handbook/values.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://docs.appflowy.io/docs/appflowy/readme.md?ask=<question>
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.