Giter VIP home page Giter VIP logo

Comments (11)

tpetricek avatar tpetricek commented on July 20, 2024

Hmm... I'm not entirely sure what to do here, because *whatever* is Markdown command for italics - this does not make too much sense for your sample, but I'm not sure how we could determine that.

Perhaps you could format paths in the documentation as inline code using backticks. Something like:

which are specified in `"./**/packages.config"` 

I believe that should work and it should be turned into:

which are specified in "./**/packages.config"

from fsharp.formatting.

forki avatar forki commented on July 20, 2024

Actually I can change it to normal style if it's to difficult.

from fsharp.formatting.

tpetricek avatar tpetricek commented on July 20, 2024

It's tricky, because

  • *foo**bar* should become [em]foo**bar[/em] but
  • *foo**bar**goo* should become [em]foo[strong]bar[/strong]goo[/em] (I guess, although SO doesn't do this)
  • but I have no idea what would be the expected result for e.g. *foo**b*r**goo*

...but I guess it's doable. When looking for the end of an inline formatting command, we could continue searching until we find something with a well-balanced body (now, we just look for the first possible ending point). The specification is not particularly clear.

Also, I think you should be able to escape things using \ so try *"./\*\*/packages.config"* (if that does not work, then that's a bug). This does not seem to work on GitHub

_"./_/packages.config"

but it does work on StackOverflow...

from fsharp.formatting.

forki avatar forki commented on July 20, 2024

I tried to escape - didn't work

from fsharp.formatting.

tpetricek avatar tpetricek commented on July 20, 2024

Thanks, I'll look into that!

from fsharp.formatting.

tpetricek avatar tpetricek commented on July 20, 2024

Escaping should now work. Let me know if it does not.

from fsharp.formatting.

forki avatar forki commented on July 20, 2024

yay. works.

Are there any other changes in the last release? Do I need to update my templates?

from fsharp.formatting.

tpetricek avatar tpetricek commented on July 20, 2024

I just pushed a new version to NuGet, which does not bring anything significantly new, but changes how the templating is handled (so you can have just a single template for documentation generated from scripts and API reference).

Also, the templates are included in the NuGet package, so you can only edit the master template (with links etc.) but just use module/type/namespace templates from the package - so hopefully you won't need to update those yourself.

See the details (and sample usage) here: fsprojects/ProjectScaffold#12

from fsharp.formatting.

forki avatar forki commented on July 20, 2024

This? fsprojects/FAKE@5d6b6cf

from fsharp.formatting.

tpetricek avatar tpetricek commented on July 20, 2024

This is part of it - it lets you specify multiple template paths, so that you can include both the standard ones (in the FSharp.Formatting NuGet package) and a path with your own customized templates (your should be first, to override the default ones).

from fsharp.formatting.

forki avatar forki commented on July 20, 2024

Mhm. all I want to do at the moment is to customize the menu.

The other stuff can be used from the default templates

from fsharp.formatting.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.