Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
ci
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Enhanced Data Sessions article prepared with Manubot

HTML Article PDF article DOI GitHub release (latest SemVer) GitHub Release Date GitHub repo size GitHub last commit GitHub issues GitHub pull requests

Manuscript description

This repository contains all versions and revisions made to the complete text of an article by Paul McIlvenny.

  • A first draft of the article was written in October 2019.
  • A second draft was prepared in July and August 2020 using Manubot and a private GitHub repository, as well as Pandoc, GitKraken, VScode and other open source software.
  • The final draft was made public on @QUIVIRR in a GitHub repository using Manubot, and a preprint PDF was uploaded to SocArXiv.
  • Some of the figures are archived on FigShare and the video is available on YouTube and archived on Zenodo.
  • The article was published (December 2020) in the QUIVIRR: Qualitative Video Research Reports journal in RICH HTML and PDF formats.
  • Updates and corrections to the raw article in markdown [see the content folder] will be version controlled in this GitHub repository.
  • The latest (not yet formatted for QuiViRR) versions of the article are available here (HTML or PDF). These versions are updated automatically every time a commit with changes is made to the repository.

What is Manubot?

Manubot is a system for writing scholarly manuscripts via GitHub. Manubot automates citations and references, versions manuscripts using git, and enables collaborative writing via GitHub. An overview manuscript presents the benefits of collaborative writing with Manubot and its unique features. The rootstock repository is a general purpose template for creating new Manubot instances, as detailed in SETUP.md. See USAGE.md for documentation how to write a manuscript.

Please open an issue for questions related to Manubot usage, bug reports, or general inquiries.

Repository directories & files

The directories are as follows:

  • content contains the manuscript source, which includes markdown files as well as inputs for citations and references. See USAGE.md for more information.
  • output contains the outputs (generated files) from Manubot including the resulting manuscripts. You should not edit these files manually, because they will get overwritten.
  • webpage is a directory meant to be rendered as a static webpage for viewing the HTML manuscript.
  • build contains commands and tools for building the manuscript.
  • ci contains files necessary for deployment via continuous integration.

Local execution

The easiest way to run Manubot is to use continuous integration to rebuild the manuscript when the content changes. If you want to build a Manubot manuscript locally, install the conda environment as described in build. Then, you can build the manuscript on POSIX systems by running the following commands from this root directory.

# Activate the manubot conda environment (assumes conda version >= 4.4)
conda activate manubot

# Build the manuscript, saving outputs to the output directory
bash build/build.sh

# At this point, the HTML & PDF outputs will have been created. The remaining
# commands are for serving the webpage to view the HTML manuscript locally.
# This is required to view local images in the HTML output.

# Configure the webpage directory
manubot webpage

# You can now open the manuscript webpage/index.html in a web browser.
# Alternatively, open a local webserver at http://localhost:8000/ with the
# following commands.
cd webpage
python -m http.server

Sometimes it's helpful to monitor the content directory and automatically rebuild the manuscript when a change is detected. The following command, while running, will trigger both the build.sh script and manubot webpage command upon content changes:

bash build/autobuild.sh

Continuous Integration

Whenever a pull request is opened, CI (continuous integration) will test whether the changes break the build process to generate a formatted manuscript. The build process aims to detect common errors, such as invalid citations. If your pull request build fails, see the CI logs for the cause of failure and revise your pull request accordingly.

When a commit to the master branch occurs (for example, when a pull request is merged), CI builds the manuscript and writes the results to the gh-pages and output branches. The gh-pages branch uses GitHub Pages to host the following URLs:

For continuous integration configuration details, see .github/workflows/manubot.yaml if using GitHub Actions or .travis.yml if using Travis CI.

License

License: CC BY 4.0 License: CC0 1.0 License: CC BY-NC-SA 4.0

Except when noted otherwise, the entirety of this repository is licensed under a CC BY 4.0 License (LICENSE.md), which allows reuse with attribution. Please attribute by linking to https://github.com/manubot/rootstock.

Since CC BY is not ideal for code and data, certain repository components are also released under the CC0 1.0 (LICENSE CC0) and the CC BY 4.0 (LICENCE CC BY-NC-SA 4.0) public domain dedication. All files matched by the following glob patterns are dual licensed under CC BY 4.0 and CC0 1.0:

  • *.sh
  • *.py
  • *.yml / *.yaml
  • *.json
  • *.bib
  • *.tsv
  • .gitignore

All other files are only available under LICENSE CC BY-NC-SA 4.0, including:

  • *.md
  • *.html
  • *.pdf
  • *.docx

About

Article by Paul McIlvenny created using Manubot and Pandoc Scholar

Resources

License