Skip to content

Commit

Permalink
update with intro and conclusion
Browse files Browse the repository at this point in the history
  • Loading branch information
prudhomm committed Jul 17, 2024
1 parent 08d79ea commit 6f8e432
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 3 deletions.
3 changes: 3 additions & 0 deletions .github/workflows/latex.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ jobs:
runs-on: ubuntu-latest
outputs:
prefix: ${{ steps.repo_name.outputs.prefix }}
env:
VERSION: ${{ github.ref_name }}
steps:
- name: Set up Git repository
uses: actions/checkout@v4
Expand All @@ -24,6 +26,7 @@ jobs:
root_file: main.tex
latexmk_shell_escape: true
post_compile: "latexmk -c; rm -rf _minted*"

- name: Get Repository Name
id: repo_name
run: |
Expand Down
8 changes: 8 additions & 0 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
= Template Repository for Articles

== Introduction

Writing scientific articles using LaTeX offers numerous advantages, including precise typesetting, seamless integration of references, and robust version control.
This template repository demonstrates best practices for organizing LaTeX projects, utilizing GitHub Actions for automated document compilation, managing bibliographies with Zotero, and optimizing image handling.
By following this template, researchers can enhance their workflow efficiency and ensure consistent document formatting across platforms like Overleaf and local LaTeX installations.
The releases assets produced by the GitHub Actions allows to upload the article to HAL, arXiv, Zenodo, etc.


== Image Naming Convention

To ensure compatibility with platforms like HAL, arXiv, and Overleaf, name your images with the `img-*` prefix and store them in the same directory as the `.tex` file. This makes it easier to manage and upload your images along with your LaTeX document.
Expand Down
26 changes: 23 additions & 3 deletions main.tex
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
\usepackage{minted}
\usepackage{natbib}

\CatchFileDef{\myversion}{|echo $VERSION}{}
% Define custom color
\definecolor{CustomBlue}{rgb}{0.25, 0.41, 0.88} % RoyalBlue
% Set up hyperref with the custom citecolor
Expand Down Expand Up @@ -39,13 +41,23 @@
\begin{document}
\title{Template Repository for Articles}
\author{Christophe Prud'homme\thanks{Université de Strasbourg, France}}
\title{Template Repository for Articles\\ \small\tt Version \myversion}
\author{Christophe Prud'homme\thanks{Cemosis, IRMA UMR 7501, Université de Strasbourg, CNRS, France, \tt \href{mailto:[email protected]}{[email protected]}}}
\maketitle
\tableofcontents
\section{Introduction}
\label{sec:introduction}
Writing scientific articles using LaTeX offers numerous advantages, including precise typesetting, seamless integration of references, and robust version control.
This template repository demonstrates best practices for organizing LaTeX projects, utilizing GitHub Actions for automated document compilation, managing bibliographies with Zotero, and optimizing image handling.
By following this template, researchers can enhance their workflow efficiency and ensure consistent document formatting across platforms like Overleaf and local LaTeX installations.
The releases assets produced by the GitHub Actions allows to upload the article to HAL, arXiv, Zenodo, etc.
\section{Image Naming Convention}
To ensure compatibility with platforms like HAL, arXiv, and Overleaf, name your images with the \texttt{img-*} prefix and store them in the same directory as the \texttt{.tex} file. This makes it easier to manage and upload your images along with your LaTeX document.
To ensure compatibility with platforms like HAL, arXiv, and Overleaf, name your images with the \texttt{img-*} prefix and store them in the same directory as the \texttt{.tex} file.
This makes it easier to manage and upload your images along with your LaTeX document.
\textbf{Example}:
\begin{itemize}
Expand Down Expand Up @@ -169,6 +181,14 @@ \subsection{Update References from Zotero}
\item Overleaf will automatically sync the changes, ensuring your references are up to date.
\end{enumerate}
\section{Conclusion}
\label{sec:conclusion}
This template provides a comprehensive approach for creating and managing LaTeX articles, integrating modern tools and workflows to enhance productivity and collaboration.
By leveraging GitHub Actions for automated compilation, Zotero for reference management, and Overleaf for online editing, researchers can streamline the writing process and focus more on content creation.
The structured setup ensures consistent formatting and efficient handling of images and references, making it suitable for both individual use and collaborative projects.
\bibliographystyle{plain}
\bibliography{references}
\end{document}

0 comments on commit 6f8e432

Please sign in to comment.