Giter VIP home page Giter VIP logo

maehr / academic-pandoc-template Goto Github PK

View Code? Open in Web Editor NEW
208.0 5.0 34.0 41.37 MB

Write beautifully typeset academic texts with distraction-free Markdown and Pandoc.

Home Page: https://maehr.github.io/academic-pandoc-template/

License: MIT License

TeX 3.89% HTML 95.39% SCSS 0.01% Shell 0.01% Makefile 0.05% Lua 0.67%
pandoc-template pdf docx academic-publishing markdown-converter docx-generator pdf-generator tectonic latex-template markdown pandoc latex github-action github-actions

academic-pandoc-template's Introduction

Academic Pandoc template

Pandoc markdown templates for academic articles, presentations and theses to write distraction-free while maintaining beautiful typesetting.

GitHub issues GitHub forks GitHub stars GitHub license DOI

from md article presentation thesis
to html
to docx
to epub
to pdf
to pptx
to tex

Getting Started

Follow the The Markdown Guide and make sure you have a Markdown editor like Zettlr and a Bibtex editor like JabRef installed.

Use it online

  1. Use this template or fork this repository.
  2. Edit article/article.md, presentation/presentation.md or thesis/ according to the The Markdown Guide online, with Zettlr or another Markdown editor
  3. Edit article/references.bib, presentation/references.bib or thesis/references.bib online, with JabRef or with your favorite Bibtex editor
  4. Commit your changes
  5. Manually run the Pandoc GitHub actions to build your document. They will be commited to main branch as well. a. Click on Actions in the top menu b. Click on Pandoc in the left menu c. Click on Run workflow in the top right corner

Use it locally

Install all prerequisites

Open your command line and execute on of the following commands.

  • make all to build all documents
  • make article to build the article
  • make article-docx article-pdf article-tex to build the article in different formats
  • make presentation to build the presentation
  • make presentation-html presentation-pdf presentation-pptx presentation-tex to build the presentation in different formats
  • make thesis to build the thesis
  • make thesis-docx thesis-epub thesis-pdf thesis-tex to build the thesis in different formats
  • make help to get a list of all available commands

Linting and formatting

Install the latest version of Node and all dependencies.

npm install

To use linting and formatting, use the following commands.

npm run check
npm run format

Configuration

Change the variables in the frontmatter in article/article.md, presentation/presentation.md or thesis/00.md to configure your document.

author:
  - '[Eleanor Roosevelt]([email protected])'
  - '[John Peters Humphrey]([email protected])'
bibliography: references.bib # bibliography to use for resolving references
csl: https://www.zotero.org/styles/chicago-note-bibliography
date: 1 January 2023
keywords: # list of keywords to be included in HTML, PDF, ODT, pptx, docx and AsciiDoc metadata; repeat as for author, above
lang: en-US

Change the default files to your needs:

Conventional Commits

Use Conventional Commits for adding human and machine readable meaning to commit messages. To use commitizen, use the following commands.

npm run commit

Support

This project is maintained by @maehr. Please understand that we won't be able to provide individual support via email. We also believe that help is much more valuable if it's shared publicly, so that more people can benefit from it.

Type Platforms
๐Ÿšจ Bug Reports GitHub Issue Tracker
๐ŸŽ Feature Requests GitHub Issue Tracker
๐Ÿ›ก Report a security vulnerability GitHub Issue Tracker

Built With

Roadmap

  • Refactoring of the article template
  • Templates for presentation and thesis
  • Change name of master branch to main
  • Improve documentation
  • Improve caching in .github/workflows/pandoc.yml

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

  • Moritz Mรคhr - Initial work - maehr

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

academic-pandoc-template's People

Contributors

maehr avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

academic-pandoc-template's Issues

231001: Migration to Quatro

Is your feature request related to a problem? Please describe.

Lua-filters are being retired. See https://github.com/pandoc/lua-filters

Describe the solution you'd like

To migrate your academic-pandoc-template repository to use quarto-actions, you'll need to do the following:

Steps:

  1. Add Quarto Configuration: Create a quarto.yml file in your repository to specify the Quarto build settings. This is similar to your existing Makefile.

  2. GitHub Actions Workflow: Create a .github/workflows/quarto-publish.yml file in your repository. You can base it on the example from quarto-actions:

    name: Quarto Publish
    
    on:
      push:
        branches:
          - main
    
    jobs:
      publish:
        runs-on: ubuntu-latest
        steps:
        - uses: actions/checkout@v2
        - uses: quarto-dev/quarto-actions/setup@v1
        - uses: quarto-dev/quarto-actions/render@v1
        - uses: quarto-dev/quarto-actions/publish@v1
          with:
            publish_dir: _site
  3. Dependencies: If your project relies on specific system dependencies, you might need to add a step in the GitHub Actions workflow to install them.

  4. Test Locally: Before pushing the changes, test the Quarto build locally to make sure everything works as expected.

  5. Push and Monitor: Once you're confident, push the changes to GitHub and monitor the Actions tab to ensure the workflow runs successfully.

Notes:

  • The quarto-actions repository provides various examples for different use-cases like freezing code, specifying dependencies, etc. You might want to look into those based on your project's needs.

  • The quarto-actions repository uses three main actions: setup, render, and publish. These are specified in the action.yml files within their respective directories.

Describe alternatives you've considered

None

Additional context

None

Include Preview

For a visual piece of code such as a template, screenshots or other means of previewing the template are highlight needed.

ascii_identifiers not supported anymore

Describe the bug
A clear and concise description of what the bug is.

To Reproduce
Steps to reproduce the behavior:

  1. Go to '...'
  2. Click on '....'
  3. Scroll down to '....'
  4. See error

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

  • OS: [e.g. iOS]
  • Browser [e.g. chrome, safari]
  • Version [e.g. 22]

Smartphone (please complete the following information):

  • Device: [e.g. iPhone6]
  • OS: [e.g. iOS8.1]
  • Browser [e.g. stock browser, safari]
  • Version [e.g. 22]

Additional context
Add any other context about the problem here.

15.04.21: [Change font style in template]

I am new to pandoc and conversion of MD files to PDF. I was really amazed by the conversion of the template with typademic! So I am not sure this is a bug or that I just am inexperienced. I tried to modify the template here and there and I noticed that if I uncomment the mainfont and change it to another one (taken from https://tug.org/FontCatalogue/sansseriffonts.html) in the PDF the font style doesn't change.

Great work I am really amazed by the simplicity of Typademic. Thanks!

Desktop (please complete the following information):

  • OS: 11.2
  • Browser Chrome
  • Version 89

Various typos

Describe the bug
Undertitel instead of untertitel and some more

To Reproduce
Steps to reproduce the behavior:

  1. Go to '...'
  2. Click on '....'
  3. Scroll down to '....'
  4. See error

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

  • OS: [e.g. iOS]
  • Browser [e.g. chrome, safari]
  • Version [e.g. 22]

Smartphone (please complete the following information):

  • Device: [e.g. iPhone6]
  • OS: [e.g. iOS8.1]
  • Browser [e.g. stock browser, safari]
  • Version [e.g. 22]

Additional context
Add any other context about the problem here.

MD/LaTeX -> PDF: bibliography running off page when penalties=10000

Describe the bug
jgm/pandoc#3255

To Reproduce
Steps to reproduce the behavior:

  1. Go to '...'
  2. Click on '....'
  3. Scroll down to '....'
  4. See error

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

  • OS: [e.g. iOS]
  • Browser [e.g. chrome, safari]
  • Version [e.g. 22]

Smartphone (please complete the following information):

  • Device: [e.g. iPhone6]
  • OS: [e.g. iOS8.1]
  • Browser [e.g. stock browser, safari]
  • Version [e.g. 22]

Additional context
Add any other context about the problem here.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.