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.

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

Jazzy doesn't escape ? in URLs #547

Closed
lilyball opened this issue Apr 29, 2016 · 3 comments
Closed

Jazzy doesn't escape ? in URLs #547

lilyball opened this issue Apr 29, 2016 · 3 comments

Comments

@lilyball
Copy link

If I have a documented implementation of the ?? operator, Jazzy creates a file Functions/??(_:_:).html, but it doesn't escape the ? in hyperlinks to this function. This includes the hyperlink in the sidebar as well as the "See more" hyperlink when looking at the Functions page. The hyperlinks end up looking something like <a href="Functions/??(_:_:).html">See more</a>, and clicking on this hyperlink ends up showing the Functions folder in the Finder (as the ? is interpreted as the beginning of a query string).

jazzy version: 0.6.0

@jpsim
Copy link
Collaborator

jpsim commented Apr 29, 2016

Thanks for filing this! We really should improve our URL generation sanitization in general.

@karagraysen
Copy link
Contributor

I see that #558 needs to be reviewed and merged.

@SDGGiesbrecht
Copy link
Contributor

The configuration option use_safe_filenames and the corresponding flag --use-safe-filenames are now available. Until 0.7.4 is released, you can build and run from source (in your project directory):

git clone https://github.com/realm/jazzy
cd jazzy
bundle install
cd ..
jazzy/bin/jazzy --use-safe-filenames
rm -rf jazzy

Any other flags you normally use (such as --clean) can be added to the second last line.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants