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

Ability to automatically use the project version in Markdown pages #184

Open
simon-brooke opened this issue May 1, 2019 · 1 comment
Open

Comments

@simon-brooke
Copy link

It's fairly common in Clojure documentation to have the following snippet:

## Usage

To use this library in your project, add the following leiningen dependency:

    [org.clojars.simon_brooke/html-to-md "0.3.0"]

In my experience (and I'd love to hear from anyone who knows better) this line has to be manually edited at every release. I'd like to be able to put a magic token, e.g. {{version}} and have it magically update to the current project version.

Explicitly, I'd like to write:

## Usage

To use this library in your project, add the following leiningen dependency:

    [org.clojars.simon_brooke/html-to-md "{{version}}"]

and have it appear in the generated documentation:

Usage

To use this library in your project, add the following leiningen dependency:

[org.clojars.simon_brooke/html-to-md "0.4.0-SNAPSHOT"]
@weavejester
Copy link
Owner

Adding tokens to the documentation sounds fine, though I'm not sure how useful it would be for most people, as the "Usage" information is typically in the README, which people usually read through Github etc. rather than Codox.

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