Skip to content
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

Jump to bottom

Fix README links #65

Merged
merged 4 commits into from
Mar 29, 2023
Merged

Fix README links #65

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
789b0b3
Are these fixed?
kaspth Mar 29, 2023
54d8c25
Like this?
kaspth Mar 29, 2023
c5c292c
Ok, maybe this?
kaspth Mar 29, 2023
e4ec26f
Fix 'em. Fix 'em all.
kaspth Mar 29, 2023
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
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Here's how to showcase a standard button component written with standard Rails p

### Components with ViewComponent

If we take the `MessageComponent` as seen on [https://viewcomponent.org]():
If we take the `MessageComponent` as seen on [https://viewcomponent.org](https://viewcomponent.org):

```ruby
# app/components/message_component.rb
Expand Down Expand Up @@ -256,7 +256,7 @@ end

By default, Showcase's syntax highlighting runs on Rouge's `"github"` theme.

To use a different theme, override [showcase/engine/_stylesheets.html.erb]() with the following, replacing `:magritte` with a [valid theme](rouge-themes):
To use a different theme, override [showcase/engine/_stylesheets.html.erb](app/views/showcase/engine/_stylesheets.html.erb) with the following, replacing `:magritte` with a [valid theme](rouge-themes):

```erb
<%= stylesheet_link_tag "showcase" %> <%# We've removed the default showcase.highlights file here. %>
Expand All @@ -269,7 +269,7 @@ To use a different theme, override [showcase/engine/_stylesheets.html.erb]() wit

### View examples

Clone the repository, run `bundle install`, then run `bin/rails server`, and visit localhost:3000 in your browser. You'll see the examples from [test/dummy/app/views/showcase/previews]().
Clone the repository, run `bundle install`, then run `bin/rails server`, and visit localhost:3000 in your browser. You'll see the examples from [test/dummy/app/views/showcase/previews](test/dummy/app/views/showcase/previews).

### Configuring what trees to open

Expand Down Expand Up @@ -313,7 +313,7 @@ Call `showcase.link_to` with the URL path to the other Showcase:

Showcase also supports custom options contexts. They're useful for cases where the options have a very specific format and it would be nice to keep them standardized.

By default, Showcase ships Nice Partials and Stimulus contexts out of the box. See [lib/showcase.rb]() for how they're defined.
By default, Showcase ships Nice Partials and Stimulus contexts out of the box. See [lib/showcase.rb](lib/showcase.rb) for how they're defined.

To add a new context, you can do this:

Expand Down Expand Up @@ -388,9 +388,9 @@ partials, make sure to include `"showcase"` in your list of assets.

[javascript_include_tag]: https://edgeapi.rubyonrails.org/classes/ActionView/Helpers/AssetTagHelper.html#method-i-javascript_include_tag
[stylesheet_link_tag]: https://edgeapi.rubyonrails.org/classes/ActionView/Helpers/AssetTagHelper.html#method-i-stylesheet_link_tag
[showcase/engine/_head.html.erb]: ./showcase/engine/_head.html.erb
[showcase/engine/_javascripts.html.erb]: ./showcase/engine/_javascripts.html.erb
[showcase/engine/_stylesheets.html.erb]: ./showcase/engine/_stylesheets.html.erb
[showcase/engine/_head.html.erb]: app/views/showcase/engine/_head.html.erb
[showcase/engine/_javascripts.html.erb]: app/views/showcase/engine/_javascripts.html.erb
[showcase/engine/_stylesheets.html.erb]: app/views/showcase/engine/_stylesheets.html.erb

## Contributing
Contribution directions go here.
Expand Down