Skip to content

Create, edit and display a journal article, entirely in GitHub

License

Notifications You must be signed in to change notification settings

harryhoch/paper-now

 
 

Repository files navigation

Paper Now

Create, edit and (optionally) display a journal article, entirely in GitHub.

In contrast to the more traditional process of submit > peer-review > publish at PeerJ, or even the less formal preprints at PeerJ Preprints or arXiv, Paper Now is an experiment to see where the future may go with scholarly communication. Initially, it may be that co-authors collaborate either privately or publicly on GitHub and then proceed to submitting to PeerJ or other journals for formal peer-review or preprinting. Or perhaps this is where the traditional medium of publication begins to diverge. There is no end goal other than to see what the academic community wants, which is why this is completely open to fork, extend, and build upon.

See an example article

Instructions

  1. Fork this repository to your own account
  2. Edit the article metadata
  3. Add data*, figures and tables
  4. Edit each section
  5. View your article in GitHub Pages at https://{username}.github.io/paper-now

Notes

  • Paper Now is at a very experimental stage; it may progress further if people find it useful.
  • Paper Now is inspired by Jekyll Now.
  • If you rename your forked repository, you also need to change the baseurl setting in _config.yml to match.
  • It's not possible to fork the same repository twice in GitHub, so to create a second article you'll need to create a new repository in GitHub, clone this repository locally and push it to your new repository.
  • *There isn't currently a way to upload binary files using GitHub's web interface, so you'll need to do this locally. GitHub's desktop client is probably the easiest way to clone a repository, add files and push the changes back to GitHub.

Feedback

  • Does this article structure make sense? Would it be better all in one file? Create an issue to discuss it.
  • Made changes to the layout templates or some other part of the code? Send a pull request.

About

Create, edit and display a journal article, entirely in GitHub

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 70.9%
  • CSS 15.1%
  • JavaScript 12.2%
  • Ruby 1.3%
  • Shell 0.5%