Skip to content

Commit 06ac09f

Browse files
committed
Add demo to README & gemspec
Fixes #114
1 parent 2adfed8 commit 06ac09f

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,11 @@
22

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

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

77
Key links:
88

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

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

309310
**CSS Features:**
311+
310312
- CSS Custom Properties (CSS Variables) - Required for theming
311313
- `@media (prefers-color-scheme: dark)` - Required for automatic dark mode
312314
- Flexbox
313315
- CSS Transforms and Transitions
314316

315317
**JavaScript Features:**
318+
316319
- ES6+ syntax (arrow functions, `const`/`let`, template literals)
317320
- `sessionStorage` API - For sidebar resize persistence
318321
- DOM APIs: `querySelector`, `addEventListener`, etc.

graphql-docs.gemspec

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
2121
spec.homepage = 'https://github.com/brettchalupa/graphql-docs'
2222
spec.license = 'MIT'
2323
spec.metadata = {
24+
"homepage_uri" => "https://graphql-docs.bcodes.me",
2425
"bug_tracker_uri" => "https://github.com/brettchalupa/graphql-docs/issues",
2526
"changelog_uri" => "https://github.com/brettchalupa/graphql-docs/blob/main/CHANGELOG.md",
2627
"wiki_uri" => "https://github.com/brettchalupa/graphql-docs/wiki",

0 commit comments

Comments
 (0)