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

Setting root for links generated by fsdocs #785

Closed
davedawkins opened this issue Jan 8, 2023 · 4 comments
Closed

Setting root for links generated by fsdocs #785

davedawkins opened this issue Jan 8, 2023 · 4 comments

Comments

@davedawkins
Copy link
Contributor

davedawkins commented Jan 8, 2023

This is how I'm doing it now, to test locally:

    <PackageProjectUrl>..</PackageProjectUrl>
    <!-- <PackageProjectUrl>https://github.com/DaveDawkins/Sutil</PackageProjectUrl> -->

in order to have root set as shown here

Substitutions/parameters:
  root --> ../
  fsdocs-authors --> David Dawkins
  fsdocs-collection-name --> Sutil
  fsdocs-collection-name-link --> ../

Is there a better way? (reading the source suggests that it will derive root from <PackageProjectUrl> only

Thank you!

@nhirschey
Copy link
Collaborator

You can specify parameters at the command line.

dotnet fsdocs build --parameters root ../
Substitutions/parameters:
  root --> ../

@davedawkins
Copy link
Contributor Author

davedawkins commented Jan 8, 2023

That is useful to know, thank you. Just to make sure I'm not missing anything, does it mention root in that page there, or how to rebase links? If not, then I can submit a doc PR

@davedawkins
Copy link
Contributor Author

Tested, that works - thanks again

@nhirschey
Copy link
Collaborator

It's there but not super explicit and there's no examples. It could probably be improved. At the bottom of the templates and substutions section that you were referencing it mentions

For the fsdocs tool, additional substitutions can be specified using --parameters.

The command line tool --help output does a better job documenting it, showing the "--parameters key value" format.

davedawkins added a commit to davedawkins/FSharp.Formatting that referenced this issue Jan 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants