Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 6 additions & 4 deletions docs/en/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
- BeeWare Docs Tools Demo Section One
- [BeeWare Docs Tools Demo Section One](section_one/index.md)
- [Section One - Page Two](section_one/page_two.md)
- [Section Two](section_two/index.md)
- BeeWare Docs Tools Demo section one
- [BeeWare Docs Tools Demo section one](section_one/index.md)
- [Section one - page two](section_one/page_two.md)
- [Section two](section_two/index.md)
- [Section three](section_three/index.md)
- ./section_three/*
37 changes: 23 additions & 14 deletions docs/en/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,34 +2,43 @@

## Theme checklist

Things to manually check:
This demo is designed to test the various features of the BeeWare
MkDocs Material theme overrides. Please read through and verify
that everything listed on this and the following pages is present
and functioning as detailed in the description.

### Titlebar
## Titlebar

A medium-gray titlebar is on the page. This the theme template
has been applied.

### Header and logo icons
## Header icon

The header icon top-left has been rendered. This confirms the template
can reference external resources.

The logo icon in the left sidebar has been rendered. This confirms the
sidebar will render properly on the target sites.
## Homepage sidebar icon

### Heading font
The logo icon in the left sidebar has been rendered. The logo should be
the width of, and of equal height to, the sidebar. The site title should
be rendered below it in slightly larger font than the rest of the
sidebar, with the version number below it in smaller font.

This confirms the sidebar will render properly on the target sites.

## Heading font

Headings are rendered in Cutive. This confirms the BeeWare custom CSS
theme has been applied.

### Inline Code
## Inline code

Inline code is rendered in the same color as the surrounding font. This
confirms that the theme has not caused any undesired changes.

This is text with `inline code` here and `inline code` here.

### Tabbed Content Code
## Tabbed content code

Code is in a contrasting color to the background. Copy button should
copy only the commands; the prompt should not be included.
Expand Down Expand Up @@ -61,7 +70,7 @@ C:\...>git clone https://github.com/beeware/beeware-theme.git

///

### Code copy button behavior
## Code copy button behavior

The copy button on the following codeblock should result in `from pathlib
import Path` being copied to the clipboard.
Expand All @@ -81,14 +90,14 @@ docs pyproject.toml requirements.docs.txt
LICENSE README.md src
```

### Sidebar links
## Sidebar links

Sidebar links exist, and point to the `beeware-docs-tools` repo. This
confirms that the sidebar content has been loaded, and the `project-name`
has been set in the MkDocs configuration file, and the version number is
computed and added.

### Link colors
## Link colors

This link to [the main BeeWare website](https://beeware.org) should be blue
in *both* light mode and dark mode.
Expand All @@ -98,7 +107,7 @@ The links in the left and right sidebars should also be blue in both modes.
When scrolling down the page, the active header link in the right sidebar
should be light blue in dark mode, and darker blue in light mode.

### Translation Admonition
## Translation admonition

The English-language version of this document should show the "Translations
are available" admonition below. The French translation should show the "This is
Expand Down Expand Up @@ -143,7 +152,7 @@ machine translation, or not translated at all.

{% endif %}

### Custom 404 page
## Custom 404 page

Add `nopage` to the end of the URL in your browser to verify the 404
page contains two flying bees, and the text "Brutus can't find what
Expand All @@ -152,7 +161,7 @@ you're looking for" below.
*MkDocs builds fail with unrecognized internal links, so you need to
manually verify this check by modifying the URL in your browser.*

### Next Checks
## Next checks

The following link should take you to BeeWare Docs Tools Demo Section
One. It is included to verify cross-page linking.
Expand Down
16 changes: 12 additions & 4 deletions docs/en/section_one/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
# BeeWare Docs Tools Demo Section One
# BeeWare Docs Tools Demo section one

## Include External Markdown from a Local File
## Non-homepage sidebar logo

The logo icon in the left sidebar should be small on all pages other than the
homepage. The site title and version number should be rendered next to it with
the site title in slightly larger font, and the version number in smaller font.

This verifies that the theme is being properly applied.

## Include external markdown from a local file

The following section should have only a header, and a paragraph with inline code
followed by a code block. There should be no text between the code block and the
Expand All @@ -9,7 +17,7 @@ local files.

-8<- "include_content.md:local-content"

## Include External Markdown from a URL
## Include external markdown from a URL

The following section should have only a header, some text and a Markdown list.
This verifies that the external include extension is working, and that
Expand All @@ -19,6 +27,6 @@ This verifies that the external include extension is working, and that
https://raw.githubusercontent.com/beeware/beeware-docs-tools/refs/heads/main/docs/include_content.md:remote-content
-8<-

## Footer Navigation
## Footer navigation

Navigate to *Section One - Page Two* for the final check.
2 changes: 1 addition & 1 deletion docs/en/section_one/page_two.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# BeeWare Docs Tools Demo Section One: Page Two
# BeeWare Docs Tools Demo section one: page two

### Footer and navigation links

Expand Down
5 changes: 5 additions & 0 deletions docs/en/section_three/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# BeeWare Docs Tools Demo section three

This section and its children are included for sidebar scroll testing. Verify the
scrollbar is navigable on smaller-height displays, that you can scroll the entire
list (Page 01 - Page 12), and that it is not overlapping the footer.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
2 changes: 1 addition & 1 deletion docs/en/section_two/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# BeeWare Docs Tools Demo Section Two
# BeeWare Docs Tools Demo section two

### Images subdirectory

Expand Down
18 changes: 13 additions & 5 deletions docs/locales/de/LC_MESSAGES/SUMMARY.po
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ msgid ""
msgstr ""
"Project-Id-Version: PACKAGE VERSION\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2025-08-25 22:35+0000\n"
"POT-Creation-Date: 2025-08-25 23:52-0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
Expand All @@ -13,17 +13,25 @@ msgstr ""
"X-Generator: Translate Toolkit 3.15.6\n"

#: docs/en/SUMMARY.md:1
msgid "BeeWare Docs Tools Demo Section One"
msgid "BeeWare Docs Tools Demo section one"
msgstr ""

#: docs/en/SUMMARY.md:1
msgid "[BeeWare Docs Tools Demo Section One]{1}"
msgid "[BeeWare Docs Tools Demo section one]{1}"
msgstr ""

#: docs/en/SUMMARY.md:1
msgid "[Section One - Page Two]{1}"
msgid "[Section one - page two]{1}"
msgstr ""

#: docs/en/SUMMARY.md:4
msgid "[Section Two]{1}"
msgid "[Section two]{1}"
msgstr ""

#: docs/en/SUMMARY.md:5
msgid "[Section three]{1}"
msgstr ""

#: docs/en/SUMMARY.md:5
msgid "./section_three/*.md"
msgstr ""
Loading