瀏覽代碼

Documentation - fix whitespace issues

LB Johnston 2 年之前
父節點
當前提交
93d3652a15
共有 3 個文件被更改,包括 13 次插入11 次删除
  1. 10 10
      docs/advanced_topics/icons.md
  2. 2 1
      docs/advanced_topics/reference_index.md
  3. 1 0
      docs/reference/pages/panels.md

+ 10 - 10
docs/advanced_topics/icons.md

@@ -6,11 +6,11 @@ Wagtail comes with an SVG icon set. The icons are used throughout the admin inte
 
 Elements that use icons are:
 
-- [Register Admin Menu Item](register_admin_menu_item)
-- [Client-side components](extending_clientside_components)
-- [Rich text editor toolbar buttons](extending_the_draftail_editor)
-- [ModelAdmin menu](modeladmin_menu_icon)
-- [StreamField blocks](custom_streamfield_blocks)
+-   [Register Admin Menu Item](register_admin_menu_item)
+-   [Client-side components](extending_clientside_components)
+-   [Rich text editor toolbar buttons](extending_the_draftail_editor)
+-   [ModelAdmin menu](modeladmin_menu_icon)
+-   [StreamField blocks](custom_streamfield_blocks)
 
 This document describes how to choose, add and customise icons.
 
@@ -18,7 +18,7 @@ This document describes how to choose, add and customise icons.
 
 An icon name corresponds with the value of `id` in the SVG file: `<svg id="<name>"`.
 
-Icons are SVG files in the [Wagtail admin template folder](https://github.com/wagtail/wagtail/tree/main/wagtail/admin/templates/wagtailadmin/icons). 
+Icons are SVG files in the [Wagtail admin template folder](https://github.com/wagtail/wagtail/tree/main/wagtail/admin/templates/wagtailadmin/icons).
 
 Alternatively, enable the [styleguide](styleguide) to view the available icons and their names.
 
@@ -38,10 +38,10 @@ Draw or download an icon and save it in a template folder:
 
 The `svg` tag should:
 
-- Set the `id="icon-<name>"` attribute, icons are referenced by this name
-- Set the `xmlns="http://www.w3.org/2000/svg"` attribute
-- Set the `viewBox="..."` attribute
-- Include license information, if applicable.
+-   Set the `id="icon-<name>"` attribute, icons are referenced by this name
+-   Set the `xmlns="http://www.w3.org/2000/svg"` attribute
+-   Set the `viewBox="..."` attribute
+-   Include license information, if applicable.
 
 Set `<path fill="currentColor"` to give the icon the current color.
 

+ 2 - 1
docs/advanced_topics/reference_index.md

@@ -1,4 +1,5 @@
 (managing_the_reference_index)=
+
 # Managing the Reference Index
 
 Wagtail maintains a reference index, which records references between objects whenever those objects are saved. The index allows Wagtail to efficiently report the usage of images, documents and snippets within pages, including within StreamField and rich text fields.
@@ -26,4 +27,4 @@ class CentralPage(Page):
 
 ## Maintenance
 
-The index can be rebuilt with the `rebuild_references_index` management command. This will repopulate the references table and ensure that reference counts are displayed accurately. This should be done if models are manipulated outside of Wagtail.
+The index can be rebuilt with the `rebuild_references_index` management command. This will repopulate the references table and ensure that reference counts are displayed accurately. This should be done if models are manipulated outside of Wagtail.

+ 1 - 0
docs/reference/pages/panels.md

@@ -175,6 +175,7 @@ Note that you can use `classname="collapsed"` to load the panel collapsed under
         PageChooserPanel('related_page', ['demo.PublisherPage', 'demo.AuthorPage'])
 
     Passing ``can_choose_root=True`` will allow the editor to choose the tree root as a page. Normally this would be undesirable, since the tree root is never a usable page, but in some specialised cases it may be appropriate; for example, a page with an automatic "related articles" feed could use a PageChooserPanel to select which subsection articles will be taken from, with the root corresponding to 'everywhere'.
+```
 
 ### FormSubmissionsPanel