{"id":30874133,"url":"https://github.com/harmoniqs/piccolodocstemplate.jl","last_synced_at":"2026-02-11T22:45:22.492Z","repository":{"id":308456275,"uuid":"1032874891","full_name":"harmoniqs/PiccoloDocsTemplate.jl","owner":"harmoniqs","description":null,"archived":false,"fork":false,"pushed_at":"2026-02-09T04:57:20.000Z","size":21,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-02-09T10:52:38.991Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Julia","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/harmoniqs.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-08-06T01:05:44.000Z","updated_at":"2026-01-29T22:38:13.000Z","dependencies_parsed_at":"2025-08-06T03:21:40.425Z","dependency_job_id":"69340d90-038e-4cef-9f4f-b97e8c762441","html_url":"https://github.com/harmoniqs/PiccoloDocsTemplate.jl","commit_stats":null,"previous_names":["harmoniqs/doc_template","harmoniqs/piccolodocstemplate.jl"],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/harmoniqs/PiccoloDocsTemplate.jl","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harmoniqs%2FPiccoloDocsTemplate.jl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harmoniqs%2FPiccoloDocsTemplate.jl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harmoniqs%2FPiccoloDocsTemplate.jl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harmoniqs%2FPiccoloDocsTemplate.jl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/harmoniqs","download_url":"https://codeload.github.com/harmoniqs/PiccoloDocsTemplate.jl/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harmoniqs%2FPiccoloDocsTemplate.jl/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29284732,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-09T21:57:15.303Z","status":"ssl_error","status_checked_at":"2026-02-09T21:57:11.537Z","response_time":56,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: 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":[],"created_at":"2025-09-08T00:19:30.034Z","updated_at":"2026-02-11T22:45:22.487Z","avatar_url":"https://github.com/harmoniqs.png","language":"Julia","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PiccoloDocsTemplate\n\nSimply\n\n```\nPkg.add(url=\"https://github.com/harmoniqs/PiccoloDocsTemplate.jl\", rev=\"v0.3.0\")\nPkg.instantiate()\n```\n\nand then add a\n\n```\nusing MyPackageHere\nusing PiccoloDocsTemplate\n\npages = [ ... ]\n\ngenerate_docs( ... )\n```\n\n## usage notes\n\nBy default, `make_index=true`, which means the README.md for the package is used to create the index page (for Documenter, via `index.md`). Because of some rendering differences between github and documenter, sometimes we have annotate sections in the README so that our `index.md` file for Documenter is correct.\n\n1. You can hide text from the README, which needs to be included into index.md via html comment blocks. Github will not render the content of these, our `generate_index` function strips out the content inside of the comment, and replaces that entire line with the content like so (view in editor to see text content):\n\n```\n\u003c!--This will only show in the index.md in our documentation pages.--\u003e\nHere's a sentence that will only be displayed on the Github README \u003c!--It gets replaced by *this* sentence in the index.md.--\u003e\nHere's a sentence that will only be displayed on the Github README (and is just deleted from the docs pages) \u003c!----\u003e\nHere's a sentence that get's displayed in both places\n```\n\n2. Code blocks with julia syntax highlighting *and* marked \"example\" will be included into our index.md as `@example` blocks, thus being run as example code blocks when building our documentation, and warning at documentation build that the block(s) fail.\n\n(in README)\n\n### example code\n\n```julia example\n1 + 1\n```\n\n(what gets generated in index.md, nothing at end suppresses output for index pages)\n```@example\n1 + 1\nnothing # hide\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fharmoniqs%2Fpiccolodocstemplate.jl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fharmoniqs%2Fpiccolodocstemplate.jl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fharmoniqs%2Fpiccolodocstemplate.jl/lists"}