wagtail/docs/index.rst

:hidetoc: 1

Welcome to Wagtail's documentation
==================================

Wagtail is an open source CMS written in `Python <https://www.python.org/>`_ and built on the `Django web framework <https://www.djangoproject.com/>`_.

Below are some useful links to help you get started with Wagtail.

If you'd like to get a quick feel for Wagtail, try spinning up a `temporary developer environment <https://gitpod.io/#https://github.com/wagtail/wagtail-gitpod>`_ in your browser (running on Gitpod - here's `how it works <https://wagtail.org/blog/gitpod/>`_).

* **First steps**

  * :doc:`getting_started/index`
  * :doc:`getting_started/tutorial`
  * :doc:`getting_started/demo_site`
  * :doc:`tutorial/index`

* **Using Wagtail**

  * :doc:`topics/pages`
  * :doc:`topics/writing_templates`
  * :doc:`topics/images`
  * :doc:`topics/search/index`
  * :doc:`topics/snippets/index`
  * :doc:`advanced_topics/third_party_tutorials`


* **For editors**

  * `Editors guide (separate site) <https://guide.wagtail.org/>`_


Index
-----


.. toctree::
   :maxdepth: 2
   :titlesonly:

   getting_started/index
   tutorial/index
   topics/index
   advanced_topics/index
   extending/index
   reference/index
   deployment/index
   support
   editor_manual/index
   contributing/index
   releases/index
Add Sphinx Wagtail Theme (#6930) Add Sphinx Wagtail Theme 2021-04-20 09:24:17 +00:00			`:hidetoc: 1`

First pass at Sphinx docs 2014-02-18 17:45:31 +00:00			`Welcome to Wagtail's documentation`
			`==================================`

Improved front page 2015-02-11 16:12:37 +00:00			Wagtail is an open source CMS written in `Python <https://www.python.org/>`_ and built on the `Django web framework <https://www.djangoproject.com/>`_.

			`Below are some useful links to help you get started with Wagtail.`

Update links to wagtail.io website to point to wagtail.org This covers only links to the website, not other sites 2022-01-11 16:11:10 +00:00			If you'd like to get a quick feel for Wagtail, try spinning up a `temporary developer environment <https://gitpod.io/#https://github.com/wagtail/wagtail-gitpod>`_ in your browser (running on Gitpod - here's `how it works <https://wagtail.org/blog/gitpod/>`_).
Improved front page 2015-02-11 16:12:37 +00:00
			`* First steps`
Fix formatting of docs front page 2015-05-14 13:17:59 +00:00
Simplified getting started section 2015-05-28 09:12:48 +00:00			* :doc:`getting_started/index`
Add the Wagtail tutorial to docs 2015-06-01 14:30:07 +00:00			* :doc:`getting_started/tutorial`
moved styleguide to own page. renamed trying wagtail to demo site 2015-05-14 13:02:06 +00:00			* :doc:`getting_started/demo_site`
Rename "advanced tutorial" to "full tutorial" (#11260) 2023-11-20 15:22:52 +00:00			* :doc:`tutorial/index`
Improved front page 2015-02-11 16:12:37 +00:00
Rename "Creating your Wagtail site" to "Using Wagtail" I think the words "Wagtail site" implies that Wagtail sites are a thing when they are in fact just Django projects with Wagtail installed. So I think "Using Wagtail" is less likely to cause confusion. 2016-01-08 12:29:23 +00:00			`* Using Wagtail`
Fix formatting of docs front page 2015-05-14 13:17:59 +00:00
Renamed to "Page models" I think this is a good place to add some general usage docs so made the name more generic. 2015-09-21 15:13:02 +00:00			* :doc:`topics/pages`
Moved some of the reference docs into topics 2015-05-28 11:56:22 +00:00			* :doc:`topics/writing_templates`
Moved advanced image topics into advanced topics 2016-01-16 13:19:05 +00:00			* :doc:`topics/images`
Moved some of the reference docs into topics 2015-05-28 11:56:22 +00:00			* :doc:`topics/search/index`
Move snippets.md docs to its own directory 2023-04-28 06:53:42 +00:00			* :doc:`topics/snippets/index`
Renamed howto to advanced topics 2015-05-28 11:58:50 +00:00			* :doc:`advanced_topics/third_party_tutorials`
Improved front page 2015-02-11 16:12:37 +00:00

Rename "Creating your Wagtail site" to "Using Wagtail" I think the words "Wagtail site" implies that Wagtail sites are a thing when they are in fact just Django projects with Wagtail installed. So I think "Using Wagtail" is less likely to cause confusion. 2016-01-08 12:29:23 +00:00			`* For editors`
Fix formatting of docs front page 2015-05-14 13:17:59 +00:00
Fix editors guide link 2022-10-28 11:53:09 +00:00			* `Editors guide (separate site) <https://guide.wagtail.org/>`_
Docs updates 2015-02-11 17:30:03 +00:00

			`Index`
			`-----`


			`.. toctree::`
			`:maxdepth: 2`
			`:titlesonly:`

			`getting_started/index`
Rename "advanced tutorial" to "full tutorial" (#11260) 2023-11-20 15:22:52 +00:00			`tutorial/index`
Moved some of the reference docs into topics 2015-05-28 11:56:22 +00:00			`topics/index`
Renamed howto to advanced topics 2015-05-28 11:58:50 +00:00			`advanced_topics/index`
Add an 'Extending Wagtail' section to the docs 2021-07-23 16:14:21 +00:00			`extending/index`
Docs updates 2015-02-11 17:30:03 +00:00			`reference/index`
Rename deploy URL to deployment + update title 2024-09-18 20:44:10 +00:00			`deployment/index`
Docs updates 2015-02-11 17:30:03 +00:00			`support`
Re-add editor guide link (#9539) 2022-10-28 14:42:04 +00:00			`editor_manual/index`
created contrib section in docs, made amends to css styleguide 2015-04-17 20:34:54 +00:00			`contributing/index`
Docs updates 2015-02-11 17:30:03 +00:00			`releases/index`