{"id":21161901,"url":"https://github.com/princetonuniversity/c19datacollective","last_synced_at":"2025-12-29T10:05:57.900Z","repository":{"id":231724275,"uuid":"782471355","full_name":"PrincetonUniversity/c19datacollective","owner":"PrincetonUniversity","description":"Open-access website for the Nineteeth-Century Data Collective.","archived":false,"fork":false,"pushed_at":"2025-02-28T02:18:55.000Z","size":2248,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-28T09:39:51.162Z","etag":null,"topics":["digital-humanities","open-access"],"latest_commit_sha":null,"homepage":"https://c19datacollective.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PrincetonUniversity.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":"2024-04-05T11:20:57.000Z","updated_at":"2025-02-28T02:18:37.000Z","dependencies_parsed_at":"2024-05-21T16:29:04.251Z","dependency_job_id":"3c60378e-d55d-48de-b4cd-393988cd28bd","html_url":"https://github.com/PrincetonUniversity/c19datacollective","commit_stats":null,"previous_names":["princetonuniversity/c19datacollective"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PrincetonUniversity%2Fc19datacollective","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PrincetonUniversity%2Fc19datacollective/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PrincetonUniversity%2Fc19datacollective/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PrincetonUniversity%2Fc19datacollective/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PrincetonUniversity","download_url":"https://codeload.github.com/PrincetonUniversity/c19datacollective/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243606962,"owners_count":20318314,"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":["digital-humanities","open-access"],"created_at":"2024-11-20T13:18:40.676Z","updated_at":"2025-12-29T10:05:57.895Z","avatar_url":"https://github.com/PrincetonUniversity.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Nineteenth-Century Data Collective\n\nThis is the open-access website for the Nineteenth-Century Data Collective.\n\n## Getting Started\n\nThe website is generated by [Zola][zola], a static site generator written in Rust.\n\n### Install Zola\n\nConsult the [official documentation][zola-doc] for the most up-to-date installation instructions. For the impatient, however:\n\n```sh\n# macOS\n$ brew install zola  # or...\n$ sudo port install zola\n\n# Windows\n$ scoop install zola  # or...\n$ choco install zola\n\n# NixOS / Nixpkgs\n$ nix-env -iA nixpkgs.zola\n```\n\nAlternatively, download the appropriate Zola binary from [the GitHub release page][zola-release].\n\n### Clone the Repository\n\n```sh\n$ git clone https://github.com/PrincetonUniversity/c19datacollective.git\n```\n\n### Generate the Site\n\nThis will build and serve the site at `127.0.0.1:1111`: (AKA for MacOS the IP address of \"home\" for your computer with the modifier of being a private location (only accessible by you))\n\n```sh\n$ zola serve\n```\n\n## Publishing a new Dataset\n\nAll new publications are included as [pages][zola-pages] under a [section][zola-section] called [\"data\"][c19-data].\nBefore you begin, make sure you've completed the [Getting Started](#getting-started) steps above.\n\n### Convert the Data Essay\n\nIf the data essay is in another file format than Markdown, convert it to Markdown first.\n[Pandoc][pandoc] is a good tool for converting most file formats to Markdown:\n\n```sh\n$ pandoc essay.docx -o essay.md\n```\n\n### Handling Bibliography\n\nIf the data essay has a bibliography,\nmake sure each bibliographical item is its own paragraph in Markdown\n(i.e., surrounded by empty lines).\nThen, at the top of the bibliography, include the line `{% bibliography() %}`;\nat the bottom, include `{% end %}`.\nYour bibliography should look something like this:\n\n```markdown\n{% bibliography() %}\nEinstein, Albert. \"On the Electrodynamics of Moving Bodies.\" _Annalen der Physik_ 17.10 (1905): 891-921.\n\nMarx, Karl. _Capital: A Critique of Political Economy_. Translated by Ben Fowkes, vol. 1, Penguin Books, 1981.\n\nWordsworth, William, and Samuel Taylor Coleridge. _Lyrical Ballads: 1798 and 1802_. Edited by Fiona Stafford, Oxford University Press, 2013.\n{% end %}\n```\n\n`bibliography()` is a [Zola shortcode][zola-shortcode] that [takes an optional argument][bib-shortcode] `title`,\nwhich the site will use as the heading of the bibliographical section.\nTo use \"Works Cited\" as the heading instead of the default \"Bibliography\", for example, you can write:\n\n```markdown\n{% bibliography(title=\"Works Cited\") %}\nYour citations.\n{% end %}\n```\n\n### Handling Images and Figures\n\nZola supports [a feature called \"asset colocation,\"][zola-colocation]\nwhich means that you can have a directory structure like this:\n\n```\n.\n└── content\n    ├── _index.md\n    └── data\n        ├── _index.md\n        ├── essay-with-images\n        │   ├── index.md\n        │   ├── image1.png\n        │   ├── image2.png\n        │   └── figure.png\n        └── another-essay.md\n```\n\nInside `essay-with-images/index.md`, you can refer to images by their relative path:\n\n```markdown\nHere is an image: ![image 1](image1.png)\n```\n\nFor named figures that one can link to elsewhere in the essay,\nyou can use the [`figure()` shortcode][figure-shortcode]:\n\n```markdown\nA paragraph with [a link to the figure](#fig-1).\n\n{{ figure(src=\"figure.png\", caption=\"Figure 1: Growth of London population in 1882\", id=\"fig-1\") }}\n\nMore text after the figure, which can [link to the figure as well](#fig-1).\n```\n\n### Adding Frontmatter\n\n[Zola uses TOML to include metadata][zola-frontmatter] about its pages.\nAt the top of the data essay, fill in the following frontmatter:\n\n```markdown\n+++\ntitle = \"The Title of the Dataset\"\nauthors = [\"Karl Marx\", \"Friedrich Engels\"]\ndate = 2025-03-28\ndescription = \"\"\"\nOptional description, which will be displayed as a preview for the dataset.\n\"\"\"\n\n[extra]\ndoi = \"10.12345/abcd-ef67\"\npdc_url = \"https://datacommons.princeton.edu/discovery/catalog/doi-10-12345-abcd-ef67\"\n+++\n```\n\n* `title` will automatically be rendered as the heading of the data essay,\n  so no need to include it separately within the essay itself.\n\n* `description` will be used as a preview in the listing on [Our Data][our-data].\n  If you don't specify it in the frontmatter,\n  you can alternatively use [the `\u003c!-- more --\u003e` tag][zola-summary] within the body of the essay.\n\n* `extra.doi` will be rendered under the heading of the data essay.\n\n* `extra.pdc_url` is a link to the location of the dataset in [Princeton Data Commons][pdc],\n  which will be used to [render a preview of the dataset][dataview-impl]\n  (file lists and CSV previews are dynamically generated).\n\n### Naming and Placing the Data Essay\n\nIf the data essay does not include any images,\nyou can simply place it under `content/data`.\nThe name of the Markdown file corresponds to the [slug][wiki-slug] of the generated page.\nFor example, a file called `another-essay.md` will be accessible at `https://c19datacollective.com/data/another-essay/`.\n\nIf you use the asset colocation feature described in the [Handling Images and Figures](https://github.com/PrincetonUniversity/c19datacollective#handling-images-and-figures) step,\nyou should save the data essay as `content/data/essay-with-images/index.md`.\nThis essay will then be accessible at `https://c19datacollective.com/data/essay-with-images/`.\n\n### Pushing Changes to the Website\n\nMake sure the new data essay looks the way you want by running `zola serve` and navigating to `127.0.0.1:1111`.\nIf everything looks good, create a commit with the new data essay:\n\n```sh\n$ git add -A\n$ git commit -m \"content: Title of the New Data Essay\"\n$ git push\n```\n\nPushing to this repository triggers [a GitHub action][zola-gh-action] which automatically rebuilds the site.\nYou should be able to see the new essay live in a few minutes.\n\n## License\n\nThe code in this repository is under [the MIT license](LICENSE). All content that isn't code (under `content`) is released under [CC-BY-4.0](content/LICENSE).\n\n[zola]: https://www.getzola.org\n[zola-doc]: https://www.getzola.org/documentation/getting-started/installation/\n[zola-release]: https://github.com/getzola/zola/releases\n[zola-pages]: https://www.getzola.org/documentation/content/page/\n[zola-section]: https://www.getzola.org/documentation/content/section/\n[c19-data]: https://github.com/PrincetonUniversity/c19datacollective/tree/main/content/data\n[pandoc]: https://pandoc.org\n[zola-shortcode]: https://www.getzola.org/documentation/content/shortcodes/\n[bib-shortcode]: https://github.com/PrincetonUniversity/c19datacollective/blob/main/templates/shortcodes/bibliography.html\n[zola-colocation]: https://www.getzola.org/documentation/content/overview/#asset-colocation\n[figure-shortcode]: https://github.com/PrincetonUniversity/c19datacollective/blob/main/templates/shortcodes/figure.html\n[zola-frontmatter]: https://www.getzola.org/documentation/content/page/#front-matter\n[our-data]: https://c19datacollective.com/data/\n[zola-summary]: https://www.getzola.org/documentation/content/page/#summary\n[pdc]: https://datacommons.princeton.edu/discovery/\n[dataview-impl]: https://github.com/PrincetonUniversity/c19datacollective/blob/main/static/js/dataview.js\n[wiki-slug]: https://en.wikipedia.org/wiki/Clean_URL#Slug\n[zola-gh-action]: https://www.getzola.org/documentation/deployment/github-pages/\n\n## Helpful Resource for Getting Started with GitHub\nIf you would like more help on working in GitHub, check out this helpful resource from the Library Carpentries called [Getting Started with Git](https://librarycarpentry.github.io/lc-git/02-getting-started.html)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprincetonuniversity%2Fc19datacollective","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprincetonuniversity%2Fc19datacollective","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprincetonuniversity%2Fc19datacollective/lists"}