Skip to content

docs: comprehensive Sourcey-generated API documentation - #3149

Open
codeboost-tr wants to merge 1 commit into
iamkun:gh-pagesfrom
codeboost-tr:pr/gh-pages-sourcey-docs
Open

docs: comprehensive Sourcey-generated API documentation#3149
codeboost-tr wants to merge 1 commit into
iamkun:gh-pagesfrom
codeboost-tr:pr/gh-pages-sourcey-docs

Conversation

@codeboost-tr

Copy link
Copy Markdown

Summary

This PR replaces the simple landing page at \iamkun.github.io/dayjs\ with a full Sourcey-generated documentation site for Day.js, contributed by the community.

What's included

  • 10 navigable documentation pages: Introduction, Installation, Parsing, Get/Set, Manipulating, Displaying, Querying, Formatting, Plugins, I18n
  • Full-text search across all pages
  • Mobile-responsive layout with dark mode support
  • Open Graph images for social sharing
  • LLM-ready context files (llms.txt, llms-full.txt)
  • Sitemap.xml for SEO

The original landing page's links to day.js.org and GitHub are preserved in the navbar. This change makes \iamkun.github.io/dayjs\ serve as a comprehensive, searchable documentation hub for Day.js users.

Why Sourcey?

Sourcey generates framework-agnostic documentation from markdown, producing a fast, searchable static site. The source markdown files are contributor-friendly and can be extended with additional pages, plugins, or translations.

Preview

The same build is deployed for review at: https://codeboost-tr.github.io/dayjs/

Replace the simple landing page with a full Sourcey-generated
documentation site covering 10 API pages with search, OG images,
and mobile-responsive layout. The official day.js.org and GitHub
links remain accessible via the navbar.

This makes the project's GitHub Pages (iamkun.github.io/dayjs) serve
as a credible documentation home, contributed by the community.
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.

1 participant