Skip to content

Conversation

@google-labs-jules
Copy link
Contributor

This commit adds several new sections to the docs/use-case-publishing.md guide to make it more comprehensive for new publishers.

The following topics have been added:

  • Page Titles and SEO: Explains how to use Jekyll front matter to control page titles and descriptions for better SEO.
  • Previewing Locally: An advanced topic section that guides users on how to set up a local Jekyll environment to preview changes before publishing.
  • Navigation Menus: Explains how Jekyll themes often handle navigation and provides an example.
  • Limitations: A new section that clearly outlines the limitations of GitHub Pages (static sites only, usage limits, etc.) to set proper expectations.

Additionally, the section on using HTML files has been revised to be more general, clarifying that both new and existing HTML files are supported.

This commit enhances the publishing use case guide by adding several
new sections based on user feedback. It also revises the section on
HTML files to be more general.

New sections added:
- Page Titles and SEO (using Jekyll front matter)
- Previewing the site locally
- Creating a theme-based navigation menu
- A summary of the limitations of GitHub Pages
This commit introduces a new comprehensive guide for using the repository
as a publishing platform and enhances all existing documentation by
linkifying local file paths. All files have also been formatted with
Prettier.

New Content:
- A new guide, `docs/use-case-publishing.md`, has been added. It covers
  themes, content creation, advanced Markdown, embedding media, SEO,
  local previews, navigation, and platform limitations.

Enhancements:
- All Markdown files (`.md`) have been scanned, and any plain text
  mention of a local file has been converted into a relative link to
  improve repository navigation.
- The `docs/README.md` has been updated to include the new guide.
@attogram attogram marked this pull request as ready for review August 29, 2025 20:26
@attogram attogram merged commit 605d70e into main Aug 29, 2025
1 check passed
@attogram attogram deleted the docs-publishing-use-case branch August 29, 2025 20:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants