Skip to content

Conversation

@mcdurdin
Copy link
Member

@mcdurdin mcdurdin commented Dec 9, 2025

If a file __index.txt exists in a folder, it should list the .php and .md files in the desired order for display in the left hand navigation menu. A file prefixed by a hyphen will be excluded from the index, and other files not in the file will be listed in their default alphabetical order afterwards.

The example __index.txt files will be added to the keyman repository for help deployment.

Test-bot: skip
Fixes: #1780

@github-actions github-actions bot added the fix label Dec 9, 2025
@github-project-automation github-project-automation bot moved this to Todo in Keyman Dec 9, 2025
@keymanapp-test-bot
Copy link

User Test Results

Test specification and instructions

User tests are not required

@keymanapp-test-bot keymanapp-test-bot bot added this to the A19S18 milestone Dec 9, 2025
If a file __index.txt exists in a folder, it should list the .php and
.md files in the desired order for display in the left hand navigation
menu. A file prefixed by a hyphen will be excluded from the index, and
other files not in the file will be listed in their default alphabetical
order afterwards.

The example __index.txt files will be added to the keyman repository for
help deployment.

Test-bot: skip
@mcdurdin mcdurdin force-pushed the fix/1780/allow-custom-index-order branch from dccbba1 to 3720715 Compare December 9, 2025 18:01
Copy link
Contributor

@ermshiperete ermshiperete left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@mcdurdin mcdurdin merged commit 80bfc53 into master Dec 12, 2025
5 checks passed
@mcdurdin mcdurdin deleted the fix/1780/allow-custom-index-order branch December 12, 2025 17:42
@github-project-automation github-project-automation bot moved this from Todo to Done in Keyman Dec 12, 2025
@mcdurdin
Copy link
Member Author

@DavidLRowe this allows you to set the page order for files in a folder now, with __index.txt, see description above.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

bug: index doesn't show the pages of the KeymanWeb guide in the correct order

3 participants