'Found at' and 'View source'

[kaishin]

I don't think it is always useful to have the file path in the documentation. Currently I'm using Github URLs on http://neat.bourbon.io/docs/ and I find that a lot more useful.

Can this be optional?

[KittyGiraudel]

This found-at feature was quite experimental to be honest. We are not entirely sure how to use it. What we would like to do is make it possible for the user to set a base path somewhere, and then create View source links using this base path + the found-at thing.

Perhaps we could get use the repository.url key from package.json as a base-path, and then append the found-at key. I'm not quite sure how we could do this in a robust future-proof way.

I'd like everyone's opinion on this. @SassDoc/owners

[FWeinb]

I would add an option to the config. Some user might want to link somewhere else than the repo. But we should consider a way to disable it too.

[KittyGiraudel]

If key's falsy, then disable it, else try the view-source feature?

[KittyGiraudel]

@SassDoc/owners I'm moving this to 1.2. What about something like this:

• Add a base-path option to the configuration (default to null)
• If no base-path set, try fetching repository.url

Then:

• If base-path is falsy, then don't do anything
• If base-path is not falsy, add a View source link leading to base-path + found-at

What do you think?

[valeriangalliat]

The configuration is in JSON, I think it's more conventional to call it basePath.

repository.url won't help, it's a version control URL, not always HTTP, and even if HTTP there's no clue what to pass in the URL to get the actual source path. We can say "if it's HTTP and on GitHub, we remove the trailing .git, then add /blob/master/ and we can append the files paths"... but that's not a solution, and it won't cover a lot of cases.

• If base-path is falsy, then don't do anything
• If base-path is not falsy, add a View source link leading to base-path + found-at

I'm OK with that.

[FWeinb]

Don't make it this complicated. Just have a basePath option in config and only if it is set display the "Found At" category

[valeriangalliat]

+1 @FWeinb

[KittyGiraudel]

Sounds good to me. I will take care of the view side (in sassdoc-theme-light). Feel free to do the JS side.