search

google / docsy

A set of Hugo doc templates for launching open source content.
https://docsy.dev
Apache License 2.0
2.62k stars 904 forks source link

Feature Request: "Cite" in right hand pane #660

Open laszewsk opened 3 years ago

laszewsk commented 3 years ago

I noticed when working with over 100 contributors to a docsy site that there is a need by many to cite their own article/document/blog. I typically give the recommendation to install an extension to the browser. But in reality, that is just a bit too much effort. Instead it would be great to have under the "Edit this page" link another link that says "Cite" with outputin bibtex and text.

I think this is relatively easy to add (unfortunately I have no time) as we have metadata that can be used for this.

You can cite this page using the following bibtex entry:

@misc{label,
author={ AUTHOR FROM METADATA },
title = { TITLE FROM METADATA },
url = { The url as created by docsy/hugo },
note = {INFORMATION POSSIBLY FROM THE toml file } %% may not be needed
}

You can cite this page with the following text entry

AUTHOR FROM METADATA, TITLE FROM METADATA, The url as created by docsy/hugo, INFORMATION POSSIBLY FROM THE toml file
laszewsk commented 3 years ago

to bibtex you could even add

abstract = { THE DESCRIPTION FROM THE METADATA } ,

LisaFC commented 3 years ago

Oh, interesting idea! Not sure if you'd put it in the Edit this page etc. section as it's already fairly populated/busy with text, but perhaps as an option that you can switch on to appear at the end of the page along with the "Last edited" info. Thoughts?

H20220009 commented 1 year ago

Hi, is this issue still open? I want to work on this issue; please assign me to this.

Also, it would be great if you could give a reference to the directory.

laszewsk commented 1 year ago

this is still an issue

H20220009 commented 1 year ago

So, Can you assign me this issue? And can you reference the directory where I have to make the changes?

laszewsk commented 1 year ago

I am not the maintainer of the code, but I think how this works is to create a fork, work in your fork and create eventually a pull request while staying up to date with the current code.

I think important is that there is some configuration switch that allows this feature to be switched on and off, as well as a mechanism to define the http base for the url location in bibtex.

LisaFC commented 1 year ago

Hi H20220009 we don't assign issues in this project. If you would like to contribute please check out our Contributing Guidelines.