{"id":35361478,"url":"https://github.com/pdmosses/agda-material","last_synced_at":"2026-02-01T23:07:44.604Z","repository":{"id":322896301,"uuid":"962718962","full_name":"pdmosses/agda-material","owner":"pdmosses","description":"Supports generation of websites with highlighted literate Agda code","archived":false,"fork":false,"pushed_at":"2026-01-22T15:41:24.000Z","size":2430,"stargazers_count":2,"open_issues_count":2,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-23T08:38:01.152Z","etag":null,"topics":["agda","website-generation"],"latest_commit_sha":null,"homepage":"https://pdmosses.github.io/agda-material/","language":"Makefile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"unlicense","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pdmosses.png","metadata":{"files":{"readme":"docs/README.md","changelog":"CHANGELOG.md","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-04-08T15:12:31.000Z","updated_at":"2026-01-22T15:44:22.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/pdmosses/agda-material","commit_stats":null,"previous_names":["pdmosses/agda-material"],"tags_count":1,"template":true,"template_full_name":null,"purl":"pkg:github/pdmosses/agda-material","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pdmosses%2Fagda-material","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pdmosses%2Fagda-material/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pdmosses%2Fagda-material/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pdmosses%2Fagda-material/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pdmosses","download_url":"https://codeload.github.com/pdmosses/agda-material/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pdmosses%2Fagda-material/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28993908,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-01T22:01:47.507Z","status":"ssl_error","status_checked_at":"2026-02-01T21:58:37.335Z","response_time":56,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5: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":["agda","website-generation"],"created_at":"2026-01-02T00:25:11.822Z","updated_at":"2026-02-01T23:07:44.592Z","avatar_url":"https://github.com/pdmosses.png","language":"Makefile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Agda-Material\n\nAgda-Material automates the steps that the Agda back-end leaves to the user\nwhen generating a website with highlighted, hyperlinked listings of Agda code.\n\nThis is the README page for the repository [pdmosses/agda-material].\nIt explains how to create a repository for using Agda-Material.\n\nSee the [About] page for an overview of motivation and features.\n\nSee the [User Guide] for a summary of how to generate websites with\nAgda-Material.\n\n## Repository contents\n\nThe repository contains the following files:\n\n- `agda`: directory for Agda source code\n- `docs`: directory for generating a website\n    - `docs/javascripts`: directory for Javascript files\n    - `docs/stylesheets`: directory for CSS files\n    - `docs/.nav.yml`: configuration file for navigation panels\n    - `docs/about.md`: Markdown source for the [About] page\n    - `docs/README.md`: Markdown source for this [README] page\n    - `docs/Library/index.md`: Markdown source for the [Library] page\n    - `docs/Test/index.md`: Markdown source for the [Test] page\n- `CHANGELOG.md`: summary of significant bug-fixes and feature updates\n- `Makefile`: automation of website generation\n- `mkdocs.yml`: configuration file for the generated website\n- `UNLICENSE`: release into the public domain\n\nThe repository does not contain any generated files.\n\nBy default, Agda-Material creates generated files in the following directories:\n\n- `docs/html`: HTML files\n- `docs/md`: Markdown files\n- `site`: website\n- `temp`: temporary files\n\nThe default directories for Agda source code and generated files can be changed\nby editing the `Makefile`.\n\nThe location of the directory `docs` can be configured by setting `docs_dir` in\n`mkdocs.yml`.\n\n## Software dependencies\n\nAgda-Material has been tested with the software versions listed below.\nIt should produce similar results with other recent versions\n(although [Material for MkDocs] v9.7 has many more features than v9.6).\n\n- [Agda] (2.8.0)\n- [Awesome-nav] (3.2.0)\n- [GNU Make] (3.81)\n- [Material for MkDocs] (9.7.1)\n- [mike] (2.0.0)\n- [MkDocs] (1.6.1)\n- [pip] (25.3)\n- [Python 3] (3.14.0)\n- [sd] (1.0.0)\n\n## Platform dependencies\n\nAgda-Material has been developed and tested on MacBook laptops with Apple M1\nand M3 chips running macOS Sequoia (15.6) and Tahoe (26.2) with CLI Tools.\n\nPlease report any [issues] with using Agda-Material on other platforms,\nincluding all relevant details. Pull requests for addressing such issues\nare welcome.\n\n## Installing Agda-Material\n\nCheck that you have installed all the relevant\n[software dependencies](#software-dependencies).\n\nThen:\n\n### *Either* create a fresh repository\n\nOn [pdmosses/agda-material]:\n\n- Click on the **Use this template** button (near the top of the page)\n\nLocally: \n\n- Clone the resulting repository\n\n### *Or* copy files to your existing repository\n\nOn [pdmosses/agda-material]:\n\n- Click on **\u003c\u003e Code** then **Clone** or **Download**\n\nLocally:\n\n- Copy/merge the following files and directories from `agda-material`\n  to your repository:\n\n    - `Makefile`\n    - `mkdocs.yml`\n    - `agda/*`\n    - `docs/*`\n    - `.gitignore`\n\n## Testing Agda-Material\n\n1.  In a terminal from the root directory of your repository:\n\n    ```shell\n    make check\n    make web\n    make serve\n    ```\n\n2.  Then in a web browser:\n\n    - Open `localhost:8000/agda-material`\n    - Check that the local site corresponds to the [Agda-Material] website on\n      GitHub Pages (apart from the version selector)\n\n3.  In the terminal:\n\n    ```shell\n    make clean-all\n    ```\n\n    Check that the following generated directories do not exist:\n\n    - `docs/html`\n    - `docs/md`\n    - `site`\n    - `temp`\n\n## Preparing to use Agda-Material\n\n### Update the MkDocs settings\n\nIn `mkdocs.yml`, update the repository settings:\n\n- `site_name`\n- `site_url`\n- `repo_name`\n- `repo_url`\n\n### Replace the Agda modules\n\n- Remove the `agda` directory.\n- Add a directory containing your own Agda modules.\n- In `Makefile`:\n\n    - set the value of `DIR` to the directory containing your Agda modules;\n    - set the value of `ROOT` to the *name* of a module that imports\n      all the other modules to be included in your website.\n    \n    Both `DIR` and `ROOT` can be comma-separated lists.\n\n### Update Markdown source files and navigation\n\nIn the `docs` directory:\n\n- replace all `*.md` files by your own file(s);\n- your website home page should be named `index.md` or `README.md`;\n- update `.nav.yml` to create your desired navigation hierarchy.\n\nSee the [User Guide] for a summary of how to generate websites with\nAgda-Material.\n\n## Upgrading to the latest version\n\nCompare the current contents of the following files in the `main` branch with\nthe copies in your fork or clone of this repository:\n\n- `docs/javascripts/*.js`\n- `docs/stylesheets/*.css`\n- `Makefile`\n- `mkdocs.yml`\n\nCopy *all* changes that do not conflict with your own changes.\n\n## Contributing\n\nPlease report any [issues] with using Agda-Material, including all relevant\ndetails. [Pull requests] for addressing reported issues are welcome.\n[Discussions] may include queries, comments, and suggestions for improvement,\nannouncements about Agda-Material, and links to websites generated using it.\n\n## Contact\n\nPeter Mosses\n\n[p.d.mosses@tudelft.nl](mailto:p.d.mosses@tudelft.nl)\n\n[pdmosses.github.io](https://pdmosses.github.io)\n\n[About]: about.md\n[README]: README.md\n[User Guide]: user-guide.md\n[Library]: Library/index.md\n[Test]: Test/index.md\n[Agda-Material]: https://pdmosses.github.io/agda-material/\n[pdmosses/agda-material]: https://github.com/pdmosses/agda-material/\n[Discussions]: https://github.com/pdmosses/agda-material/discussions/\n[Issues]: https://github.com/pdmosses/agda-material/issues/\n[Pull requests]: https://github.com/pdmosses/agda-material/pulls/\n\n[Agda]: https://agda.readthedocs.io/en/stable/getting-started/index.html\n[GNU Make]: https://www.gnu.org/software/make/manual/make.html\n[sd]: https://github.com/chmln/sd/\n[Python 3]: https://www.python.org/downloads/\n[pip]: https://pypi.org/project/pip/\n[MkDocs]: https://www.mkdocs.org/getting-started/\n[Material for MkDocs]: https://squidfunk.github.io/mkdocs-material/getting-started/\n[Awesome-nav]: https://lukasgeiter.github.io/mkdocs-awesome-nav/\n[mike]: https://github.com/jimporter/mike/\n[GitHub Pages]: https://pages.github.com","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpdmosses%2Fagda-material","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpdmosses%2Fagda-material","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpdmosses%2Fagda-material/lists"}