-
Notifications
You must be signed in to change notification settings - Fork 191
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
Markdown Citation Renderer: pandoc style citations => proper references #91
Comments
@sdiehl any info you can share on your current setup for adding references e.g. do you have a local bib file you export to or how does it work with the obsidian plugin (Aside: shall we start documenting this kind of stuff e.g. obsidian plugin setup and config for ourselves and other potential editors in the meta section e.g. |
I'm doing this manually at the moment. It requires a lot of work and probably doesn't scale very well unless others have a huge mental map of all the literature. But if we have an automated process it's easy to reverse what I've done into something automatic. |
@rufuspollock @sdiehl is this issue been assigned to anyone yet? |
@AceTheCreator it hasn't and you could have a go at it. |
I have been reviewing this issue, and my assumptions in terms of workflow are as follows: The ultimate goal is to write something in a markdown file, as you are writing, you can insert a citation, these citations are then used either to automatically generate a bibliography/endnotes, or run the file through a script that then produces the endnotes which you can add to the file. Is this the desired outcome? I use LibreOffice and the Zotero plugin allows me to insert a citation, choose the citation from Zotero, and then generates the Bibliography/Endnotes automatically. I can change the citation style at any point, and the formatting changes are completed automatically. You are no doubt already familiar with this functionality. I am not familiar with Obsidian, is that what the majority of people are using for editing markdown files? For example, I use Atom, and am currently looking at two plugins that could help me create a similar workflow to the one I use in LibreOffice: https://github.com/oztalha/zotero-picker Before I proceed further, is there a hard requirement to use Obsidian for this workflow? As an aside, superscript numbers for citations make a text far more readable. For technical and academic journals, citing the author/year makes sense as the audience is familiar with the literature and subject, however, given the nature of this project and its target audience, it may be worth prioritizing readability over formality. |
@SalBayat sorry for slow reply - have not had a chance to review properly. Please feel free to dive in other issues - and saw the proofing PR which are themselves very useful. |
Want something like this in markdown:
To become this:
Or, a fuller version like:
See pandoc for more: https://pandoc.org/MANUAL.html#extension-citations
🎁 Bonus: generating a reference section at the end of a document ie. list of citations. This could be something that is explicitly inserted by having a special item like
[references]
just like one has[toc]
or maybe more MDX style<ReferencesList />
Acceptance
Tasks
Notes
Blah blah [@doe99; @smith2000; @smith2004].
Doe (1999)
for short and TODO style for full. Don't need customizability and can just default to one styleArchitecture
The text was updated successfully, but these errors were encountered: