Syde Jekyll Theme

Syde Jekyll Theme is a documentation-focused Jekyll theme that gives Syde's public GitHub repositories a standardized GitHub Pages site.

What is the Syde Jekyll Theme?

The Syde Jekyll Theme is a Jekyll theme that supplies layouts and styles for project documentation. It is used for Syde's public GitHub repositories to provide standardized GitHub Pages that display docs, and it is also available as a standalone theme. The theme is a fork of Just the Docs, a popular documentation theme for Jekyll, and is released under the MIT License.

Key Features

• Documentation layouts and styles — Comes with ready-made page templates and CSS so documentation pages share a uniform structure and appearance.
• Standardized GitHub Pages — Built to generate consistent documentation sites across multiple public repositories, giving each project a similar look.
• Fork of Just the Docs — Inherits the layout architecture and configuration options from Just the Docs, a well-known Jekyll documentation theme.
• Self-documenting — Includes its own /docs directory and a live demo at https://inpsyde.github.io/jekyll-syde-theme, where the theme documents itself.
• Open source under MIT — Licensed under the MIT License, permitting free use, modification, and redistribution.

Who is it for?

• Open source maintainers — Use the theme to publish project documentation on GitHub Pages without designing a custom site.
• Documentation writers — Write content in Markdown or HTML and have it rendered with a clean, navigation-friendly layout.
• Jekyll developers — Customize the theme's Liquid templates and SCSS to adapt the documentation site to specific needs.

Use cases

• Repository documentation — Standardize how each Syde repository presents its README, guides, and API references.
• Project sites — Deploy a static documentation site on GitHub Pages by combining Jekyll's build process with this theme.
• Theme base — Fork the theme further to create your own documentation-focused Jekyll theme with a known starting point.

FAQ

Is the Syde Jekyll Theme free?

Yes, it is open source under the MIT License, so you can freely use, modify, and share it.

How is this theme different from Just the Docs?

It is a fork of Just the Docs, so it shares the same foundation but is tailored for Syde's public repository documentation. You can still use most Just the Docs features and configuration.

Where can I see a demo?

The theme's own documentation is hosted at https://inpsyde.github.io/jekyll-syde-theme, which shows the layout and explains usage.

What files does the theme include?

The repository contains the Jekyll theme files along with a /docs directory containing documentation and examples.