{"id":14483512,"url":"https://github.com/textileio/papers","last_synced_at":"2025-04-10T18:41:05.743Z","repository":{"id":52076800,"uuid":"209462722","full_name":"textileio/papers","owner":"textileio","description":"Textile Whitepapers","archived":false,"fork":false,"pushed_at":"2021-05-07T18:34:10.000Z","size":27135,"stargazers_count":12,"open_issues_count":8,"forks_count":3,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-03-24T16:14:14.162Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TeX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/textileio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-09-19T04:31:53.000Z","updated_at":"2022-11-10T12:48:07.000Z","dependencies_parsed_at":"2022-09-06T12:40:38.304Z","dependency_job_id":null,"html_url":"https://github.com/textileio/papers","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textileio%2Fpapers","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textileio%2Fpapers/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textileio%2Fpapers/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textileio%2Fpapers/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/textileio","download_url":"https://codeload.github.com/textileio/papers/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248271908,"owners_count":21075800,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2024-09-03T00:01:49.435Z","updated_at":"2025-04-10T18:41:05.726Z","avatar_url":"https://github.com/textileio.png","language":"TeX","funding_links":[],"categories":["TeX"],"sub_categories":[],"readme":"# Textile Research Papers\n\nThe latest Threads Whitepaper release is available at https://docsend.com/view/gu3ywqi\n\n# Setup\n\n```bash\nbrew install pandoc pandoc-citeproc\n```\n\nIf you want to do the `Markdown -\u003e LaTeX -\u003e PDF` step below, you'll also want a working LaTeX environment. On MacOS grab it [from here](http://www.tug.org/mactex/) and follow the install instructions. The setup below should use that LaTeX install automatically.\n\n# Develop\n\nYou'll probably also want to use VSCode with the [Markdown Preview Enhanced](https://marketplace.visualstudio.com/items?itemName=shd101wyy.markdown-preview-enhanced) plugin.\n\nYou'll want to use the following settings:\n\n```json\n{\n  \"markdown-preview-enhanced.enableTypographer\": true,\n  \"markdown-preview-enhanced.breakOnSingleNewLine\": false,\n  \"markdown-preview-enhanced.usePandocParser\": true,\n  \"markdown-preview-enhanced.pandocMarkdownFlavor\": \"markdown-raw_tex+tex_math_dollars+fenced_code_attributes+backtick_code_blocks\",\n  \"markdown-preview-enhanced.pandocArguments\": \"--number-sections,--filter=pandoc-crossref\",\n  \"markdown-preview-enhanced.mathRenderingOption\": \"MathJax\",\n  \"markdown-preview-enhanced.codeBlockTheme\": \"auto.css\",\n  \"markdown-preview-enhanced.enableEmojiSyntax\": false\n}\n```\n\nWe use [pandoc crossref](https://github.com/lierdakil/pandoc-crossref) to do the internal section/fig/equation references, [pandoc citeproc](https://github.com/jgm/citeproc) for the citations. These use a special syntax in the markdown that might be slightly unfamiliar to some. The [docs are pretty good](https://pandoc.org/MANUAL.html#citations), so check those out before making citation or ref changes.\n\n# Export\n\nBuilding one of the markdown/pandoc formatted papers is relatively simple using the Makefile:\n\n```bash\ncd whitepaper\nmake pdf\n```\n\nTo generate a pretty-bare bones HTML version:\n\n```bash\npandoc -F pandoc-crossref --citeproc --number-sections index.md -o index.html --mathjax --standalone\n```\n\nTo generate a workable LaTeX file:\n\n```bash\npandoc -F pandoc-crossref --citeproc --number-sections index.md -o index.tex --standalone\n```\n\nTo generate a default PDF version via LaTeX:\n\n```bash\npandoc -F pandoc-crossref --citeproc --number-sections index.md -o index.pdf\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftextileio%2Fpapers","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftextileio%2Fpapers","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftextileio%2Fpapers/lists"}