Skip to content

Add demo to README & gemspec #172

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
brettchalupa merged 1 commit into from
Oct 15, 2025
Merged

Add demo to README & gemspec #172

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@

Ruby library and CLI for easily generating beautiful documentation from your GraphQL schema.

![sample](https://cloud.githubusercontent.com/assets/64050/23438604/6a23add0-fdc7-11e6-8852-ef41e8451033.png)
![Screenshot of sample generated docs](https://cloud.githubusercontent.com/assets/64050/23438604/6a23add0-fdc7-11e6-8852-ef41e8451033.png)

Key links:

- **Demo**: [https://graphql-docs.bcodes.me](https://graphql-docs.bcodes.me).
- **Ruby documentation**: [https://rubydoc.info/github/brettchalupa/graphql-docs.git/main](https://rubydoc.info/github/brettchalupa/graphql-docs.git/main).

## Installation
Expand Down Expand Up @@ -307,12 +308,14 @@ The documentation will display correctly, but automatic dark mode will not work:
The default templates use the following modern web features:

**CSS Features:**

- CSS Custom Properties (CSS Variables) - Required for theming
- `@media (prefers-color-scheme: dark)` - Required for automatic dark mode
- Flexbox
- CSS Transforms and Transitions

**JavaScript Features:**

- ES6+ syntax (arrow functions, `const`/`let`, template literals)
- `sessionStorage` API - For sidebar resize persistence
- DOM APIs: `querySelector`, `addEventListener`, etc.
Expand Down
1 change: 1 addition & 0 deletions graphql-docs.gemspec
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
spec.homepage = 'https://github.com/brettchalupa/graphql-docs'
spec.license = 'MIT'
spec.metadata = {
"homepage_uri" => "https://graphql-docs.bcodes.me",
"bug_tracker_uri" => "https://github.com/brettchalupa/graphql-docs/issues",
"changelog_uri" => "https://github.com/brettchalupa/graphql-docs/blob/main/CHANGELOG.md",
"wiki_uri" => "https://github.com/brettchalupa/graphql-docs/wiki",
Expand Down