tushuguan
is a template repository to create a personal (or shared)
Click Use this template button to create a new library.
Add a @aricle
type are expected to have a <LastName>_<Year>_<JournalAbbr>_v<Volume>_p<Page>
key, for example, Zeng_JChemPhys_2023_v159_p054801
.
The pre-commit will run to automatically fix the format of the
Note
GitHub Actions runs will not be triggered with the autofix commit. In this case, one can close and reopen the PR to manually trigger the GitHub Actions runs.
Note
Go to Settings
> Actions
> General
> Workflow permissions
and click Allow GitHub Actions to create and approve pull requests
.
Open a new issue with the title /new <DOI>
, such as /new 10.1063/5.0155600
.
Powered by wenxian
, a pull request will be automatically created.
Note
GitHub Actions runs will not be triggered with a PR created by the GitHub Actions itself. In this case, one can close and reopen the PR to manually trigger the GitHub Actions runs.
Click the Deployments
> bibtex
on the right side to download the merged
Use the library as a GitHub Actions step in an external
Note
If the library is private, go to Settings
> Actions
> General
> Access
to make it Accessible from other repositories.
# replace with your own library!
- name: Fetching the references
uses: njzjz/tushuguan@master
with:
output: references.bib
# compile the latex project...
- Go to nightly.link and click
Install and select your repositories
andAuthorize to see your repositories
buttons. Choose your library and fill the URL of.github/workflows/combine.yaml
. Copy the URL shown on the screen, for example, https://nightly.link/njzjz/tushuguan/workflows/combine.yaml/master/dist-combined-bib.zip. - In the Overleaf, upload a file using the copied URL.
The default filename is
dist-combined-bib.zip
. When you need to update that file, click that file and then clickrefresh
. - At the top of the
$\LaTeX$ file, add the following code:
\usepackage[backend=biber]{biblatex}
\usepackage{shellesc}
% uncompress the zip file before each compilation
\ShellEscape{unzip dist-combined-bib.zip}
\addbibresource{combined.bib}
Then you can add \cite
and printbibliography
to cite the reference you need.
For example,
This sentence is an example of using the reference from \texttt{tushuguan}\cite{Zeng_JChemPhys_2023_v159_p054801}.
\printbibliography
An example Overleaf project is given here.
Use the GitHub to search references, or use grep
on the local.