Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/katrinleinweber/scientific-markdown

Don't tex. Let pandoc tex for you!

https://github.com/katrinleinweber/scientific-markdown

Science Score: 18.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ○
    codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (8.6%) to scientific vocabulary
Last synced: 4 months ago · JSON representation ·

Repository

Don't tex. Let pandoc tex for you!

Basic Info
  • Host: GitHub
  • Owner: katrinleinweber
  • License: other
  • Language: TeX
  • Default Branch: master
  • Homepage:
  • Size: 1.54 MB
Statistics
  • Stars: 2
  • Watchers: 3
  • Forks: 1
  • Open Issues: 0
  • Releases: 0
Fork of JensErat/scientific-markdown
Created almost 11 years ago · Last pushed over 10 years ago
Metadata Files
Readme License Citation

README.md

Markdown for Scientific Publications

This provides an example for use of Markdown for scientific publications.

General Workflow

Markdown files are translated to LaTeX using Pandoc, which is more flexible than direct compilation to PDF files (and makes finding problems easier). The resulting .tex files are then typeset using latexmk. Contained citations in BibTex format are also managed by Pandoc and work output-independent.

Make sure to fetch the most recent Pandoc. Pandoc is under very active development, and depending on your distribution the packaged versions might be horribly outdated.

Beamer Presentations

presentation.md contains an example presentation (also containing some further explanation). presentation-header.tex is included in the preamble, presentation-toc.tex contains the table of contents and includes Creative Commons logo.

Generate the presentation by running make presentation (given you have make setup on your computer, otherwise run the contained commands manually).

Printed Reports

report.md is an example for a printed report using the article class. report-header.tex again is included in the preamble. report-footer.tex is added after the actual contents, and here includes the Creative Commons logo.

Generate the report by running make report (given you have make setup on your computer, otherwise run the contained commands manually).

License and Attribution

All contents are licensed under the Creative Commons Attribution ShareAlike 3.0 license.

Attribution for following files goes to:

I additionally share the files required or helpful for generating your own documents (namely makefile, presentation-header.tex, presentation-toc.tex, report-header.tex and report-footer.tex) as CC0/public domain.

Owner

  • Name: Katrin Leinweber
  • Login: katrinleinweber
  • Kind: user
  • Location: Europe
  • Company: @gitlabhq

Studied biochemistry, arctic ecology & geology, PhDed in diatom biofilms. Worked @prezi support, pharma-LIMS, in OA-DataViz @TIBHannover & taught coding @DLR-SC

Citation (citation.csl) 

<?xml version="1.0" encoding="utf-8"?>
<style xmlns="http://purl.org/net/xbiblio/csl" class="in-text" version="1.0" demote-non-dropping-particle="sort-only" default-locale="en-US">
  <info>
    <title>ACM SIG Proceedings ("et al." for 15+ authors)</title>
    <id>http://www.zotero.org/styles/acm-sig-proceedings-long-author-list</id>
    <link href="http://www.zotero.org/styles/acm-sig-proceedings-long-author-list" rel="self"/>
    <link href="http://www.acm.org/sigs/publications/proceedings-templates" rel="documentation"/>
    <author>
      <name>Naeem Esfahani</name>
      <email>nesfaha2@gmu.edu</email>
      <uri>http://mason.gmu.edu/~nesfaha2/</uri>
    </author>
    <contributor>
      <name>Chris Horn</name>
      <email>chris.horn@securedecisions.com</email>
    </contributor>
    <category citation-format="numeric"/>
    <category field="science"/>
    <category field="engineering"/>
    <updated>2013-08-29T05:27:03+00:00</updated>
    <rights license="http://creativecommons.org/licenses/by-sa/3.0/">This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 License</rights>
  </info>
  <macro name="author">
    <choose>
      <if type="webpage">
        <text variable="title" suffix=":"/>
      </if>
      <else>
        <names variable="author">
          <name name-as-sort-order="all" and="text" sort-separator=", " initialize-with="." delimiter-precedes-last="never" delimiter=", "/>
          <label form="short" prefix=" " suffix="." strip-periods="true"/>
          <substitute>
            <names variable="editor"/>
            <names variable="translator"/>
          </substitute>
        </names>
      </else>
    </choose>
  </macro>
  <macro name="editor">
    <names variable="editor">
      <name initialize-with="." delimiter=", " and="text"/>
      <label form="short" prefix=", "/>
    </names>
  </macro>
  <citation collapse="citation-number">
    <sort>
      <key variable="citation-number"/>
    </sort>
    <layout prefix="[" suffix="]" delimiter=", ">
      <text variable="citation-number"/>
    </layout>
  </citation>
  <bibliography entry-spacing="0" second-field-align="flush" et-al-min="15" et-al-use-first="1">
    <sort>
      <key macro="author"/>
      <key variable="title"/>
    </sort>
    <layout suffix=".">
      <text variable="citation-number" prefix="[" suffix="] "/>
      <text macro="author" suffix=" "/>
      <date variable="issued" suffix=". ">
        <date-part name="year"/>
      </date>
      <choose>
        <if type="paper-conference">
          <group delimiter=". ">
            <text variable="title"/>
            <group delimiter=" ">
              <text variable="container-title" font-style="italic"/>
              <group delimiter=", ">
                <group delimiter=", " prefix="(" suffix=")">
                  <text variable="publisher-place"/>
                  <date variable="issued">
                    <date-part name="month" form="short" suffix=" "/>
                    <date-part name="year"/>
                  </date>
                </group>
                <text variable="page"/>
              </group>
            </group>
          </group>
        </if>
        <else-if type="article-journal">
          <group delimiter=". ">
            <text variable="title"/>
            <text variable="container-title" font-style="italic"/>
            <group delimiter=", ">
              <text variable="volume"/>
              <group delimiter=" ">
                <text variable="issue"/>
                <date variable="issued" prefix="(" suffix=")">
                  <date-part name="month" form="short" suffix=" "/>
                  <date-part name="year"/>
                </date>
              </group>
              <text variable="page"/>
            </group>
          </group>
        </else-if>
        <else-if type="patent">
          <group delimiter=". ">
            <text variable="title"/>
            <text variable="number"/>
            <date variable="issued">
              <date-part name="month" form="short" suffix=" "/>
              <date-part name="day" suffix=", "/>
              <date-part name="year"/>
            </date>
          </group>
        </else-if>
        <else-if type="thesis">
          <group delimiter=". ">
            <text variable="title" font-style="italic"/>
            <text variable="archive_location" prefix="Doctoral Thesis #"/>
            <text variable="publisher"/>
          </group>
        </else-if>
        <else-if type="report">
          <group delimiter=". ">
            <text variable="title" font-style="italic"/>
            <text variable="number" prefix="Technical Report #"/>
            <text variable="publisher"/>
          </group>
        </else-if>
        <else-if type="webpage">
          <group delimiter=". ">
            <text variable="URL" font-style="italic"/>
            <date variable="accessed" prefix="Accessed: ">
              <date-part name="year" suffix="-"/>
              <date-part name="month" form="numeric-leading-zeros" suffix="-"/>
              <date-part name="day" form="numeric-leading-zeros"/>
            </date>
          </group>
        </else-if>
        <else-if type="chapter paper-conference" match="any">
          <group delimiter=". ">
            <text variable="title"/>
            <text variable="container-title" font-style="italic"/>
            <text macro="editor"/>
            <text variable="publisher"/>
            <text variable="page"/>
          </group>
        </else-if>
        <else-if type="bill book graphic legal_case legislation motion_picture report song" match="any">
          <group delimiter=". ">
            <text variable="title" font-style="italic"/>
            <text variable="publisher"/>
          </group>
        </else-if>
        <else>
          <group delimiter=". ">
            <text variable="title"/>
            <text variable="container-title" font-style="italic"/>
            <text variable="publisher"/>
          </group>
        </else>
      </choose>
    </layout>
  </bibliography>
</style>

GitHub Events

Total
Last Year