{"id":17321248,"url":"https://github.com/haozeke/docuyoda_starter","last_synced_at":"2026-01-30T12:34:30.012Z","repository":{"id":96926257,"uuid":"112541781","full_name":"HaoZeke/docuYoda_Starter","owner":"HaoZeke","description":"Academic report writing  powered by pandoc and yarn.","archived":false,"fork":false,"pushed_at":"2020-04-16T20:15:14.000Z","size":7274,"stargazers_count":3,"open_issues_count":8,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-12T04:09:04.598Z","etag":null,"topics":["build-automation","gulp-tasks","latexmk","paas","pandoc","prose","tex","yarn"],"latest_commit_sha":null,"homepage":"","language":"TeX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/HaoZeke.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-11-30T00:00:33.000Z","updated_at":"2022-10-15T13:02:37.000Z","dependencies_parsed_at":null,"dependency_job_id":"d2ce7d87-f06d-4489-9f6b-f1d7934f39dc","html_url":"https://github.com/HaoZeke/docuYoda_Starter","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/HaoZeke/docuYoda_Starter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HaoZeke%2FdocuYoda_Starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HaoZeke%2FdocuYoda_Starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HaoZeke%2FdocuYoda_Starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HaoZeke%2FdocuYoda_Starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HaoZeke","download_url":"https://codeload.github.com/HaoZeke/docuYoda_Starter/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HaoZeke%2FdocuYoda_Starter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28912911,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-30T12:13:43.263Z","status":"ssl_error","status_checked_at":"2026-01-30T12:13:22.389Z","response_time":66,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["build-automation","gulp-tasks","latexmk","paas","pandoc","prose","tex","yarn"],"created_at":"2024-10-15T13:35:59.899Z","updated_at":"2026-01-30T12:34:29.998Z","avatar_url":"https://github.com/HaoZeke.png","language":"TeX","funding_links":["https://www.paypal.me/HaoZeke/"],"categories":[],"sub_categories":[],"readme":"# docuYoda Starter Kit [![Donate](https://img.shields.io/badge/Donate-PayPal-blue.svg?style=for-the-badge)](https://www.paypal.me/HaoZeke/) [![Build Status](https://semaphoreci.com/api/v1/haozeke/docuyoda_starter/branches/master/badge.svg)](https://semaphoreci.com/haozeke/docuyoda_starter)\n\n[![Greenkeeper badge](https://badges.greenkeeper.io/HaoZeke/docuYoda_Starter.svg)](https://greenkeeper.io/)\n\n\u003e Copyright (C) 2017 Rohit Goswami \u003crohit1995@mail.ru\u003e\n\n![](readme/turtle.png \"Pandoc Papers for turtles\")\n\n**Check the output [here](https://github.com/HaoZeke/docuYoda_Starter/blob/pdf/spooky-action.pdf).**\n\nThis is the template for docuYoda rapid protoyping for academic documents.\nThe template comes with **batteries included** as it includes the dependencies for complete offline use.\n\nBoth pandoc style citations and traditional TeX citations are enabled, however keep in mind that TeX citations will not display in non-TeX files.\n\nRead about the project at it's source [here](https://www.github.com/HaoZeke/docuYoda) or on the documentation site [here](https://docuyoda.surge.sh).\n\nFor creating presentations, refer to the sibling project, [zenYoda](http://zenyoda.surge.sh/) and it's [starter template](http://zenyodasap.surge.sh/).\n\n- [Setup](#setup)\n- [Folder Structure](#folder-structure)\n- [Gulp Tasks](#gulp-tasks)\n- [Usage](#usage)\n  - [Local](#local)\n- [Install stuff](#install-stuff)\n- [Clean and produce final pdf](#clean-and-produce-final-pdf)\n  - [Acknowledgments](#acknowledgments)\n  - [TO-DO](#to-do)\n  - [License](#license)\n\n## Setup\n\nThe dependencies are very light, just a full TeX distribution and yarn (with nodejs of course).\n\n## Folder Structure\n\nThe configuration for each file is done by `yaml` files in `src/config`.\nThe gulp tasks exposed will handle appending these configurations in the form of frontmatter.\n\n**DO NOT** add any frontmatter in the `.md` files.\nInstead add global frontmatter to the `src/config/commonConf.yml` file.\n\n**DO NOT** add frontmatter delimiters to **ANY** of the configuration `yml` files either, the gulp tasks will handle those.\n\nThe pdfs are eventually generated by latexmk so the configuration file is present in `src/tex`. Typically this does not need to be edited, however, depending on the requirements feel free to change the options there.\n\nPut all images in `src/img` and refer to them with an `img/` prefix.\n\nie., if you have `cat.jpg` in `src/img` you would use regular markdown like so:\n\n```markdown\n![I am the caption](img/cat.jpg \"I'm the alt text.\")\n```\n\n## Gulp Tasks\n\n```bash\n# Runs the default\ngulp --template eisvogel\n# Runs with production settings (clean latexmk crap)\ngulp --env production --template eisvogel\n```\n\n## Usage\n\n### PaaS\n\nSimply fork the repo.\n\nEdit the content in `src/md/*.md`, along with references in `src/refs.bib` and also the appropriate configuration files in `src/config/` using any of the following:\n\n- Github Native Editor\n- [StackEdit](https://stackedit.io) _[NOT RECOMMENED] {Adds weird cruft}_\n- [Dillinger](https://dillinger.io)\n- [Prose.io](http://prose.io) _[recommended]_\n\nYou may use any of the pandoc markdown syntax, even if the viewers above do not support the entire syntax\n\n[Prose.io](http://prose.io) is recommended because it's free and image support is basically drag and drop/ _[remember to ensure the path is `src/img/`]_\n\nYou'll need to edit the [Semaphore CI Settings](https://semaphoreci.com) for the repo as shown below:\n\n![](readme/semaSettings.png \"Settings\")\n\n- The first build WILL TAKE around ~20 minutes.\n- Subsequent builds will only take around ~6 minutes or less.\n- It's best to setup the CI immediately on forking the repository, then start working.\n\n### Local\n\nSimply clone the repo and start changing stuff!\n\nYou can enable file watching by:\n\n```bash\n# Install stuff\nyarn\n# Watch and reload\nyarn gulp watch --template eisvogel\n# Clean and produce final pdf\nyarn gulp --template eisvogel\n```\n\n## Acknowledgments\n\nThis software is built on the following:\n\n- [Pandoc](https://github.com/jgm/pandoc)\n- [TeX](https://ctan.org/)\n- [latexmk](http://mg.readthedocs.io/latexmk.html)\n- [shx](https://github.com/shelljs/shx)\n- [browsersync](https://browsersync.io)\n- [yarn](https://yarnpkg.com/en/)\n\n{# Additionally, for the site the following tools were used:\n\n- [sassc](https://github.com/sass/sassc)\n- [node-sass](https://github.com/sass/node-sass)\n- [surge](http://surge.sh)\n- [panflute](http://scorreia.com/software/panflute/)\n- [imagemin-cli](https://github.com/imagemin/imagemin-cli)\n\nThe site is built with:\n\n- [Sass](http://sass-lang.com/)\n- [CSS Gird](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Grid_Layout)\n- [CSS Variables](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_variables)\n- [Travis CI](https://travis-ci.org)\n\n## TO-DO\n\n- Add site\n- Add CI stuff\n- Add better docs\n- Improve multi-document splits\n- Better error handling\n- Consolidate the \\*Yoda tools\n- Add command line arguments\n\n## License\n\nRefer to the [project license](zenyoda.surge.sh).\n\nThe project like much of pandoc itself is under the [GNU GPLv3](https://choosealicense.com/licenses/gpl-3.0/), however, please refer to the exceptions listed [here](https://github.com/jgm/pandoc/blob/master/COPYRIGHT).\n\nPhoto by Ksenia Makagonova on Unsplash\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhaozeke%2Fdocuyoda_starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhaozeke%2Fdocuyoda_starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhaozeke%2Fdocuyoda_starter/lists"}