{"id":21088849,"url":"https://github.com/iolanguage/docio","last_synced_at":"2025-03-14T05:44:51.484Z","repository":{"id":66367832,"uuid":"112120831","full_name":"IoLanguage/docio","owner":"IoLanguage","description":"Documentation generator for Eerie packages","archived":false,"fork":false,"pushed_at":"2020-11-05T18:26:11.000Z","size":5422,"stargazers_count":0,"open_issues_count":2,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-21T00:48:49.399Z","etag":null,"topics":["docs","documentation","documentation-generator","io","site-generator","static-site-generator"],"latest_commit_sha":null,"homepage":"https://iolanguage.github.io/docio","language":"CSS","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/IoLanguage.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-26T22:12:41.000Z","updated_at":"2020-11-05T18:26:13.000Z","dependencies_parsed_at":"2023-02-21T21:45:15.453Z","dependency_job_id":null,"html_url":"https://github.com/IoLanguage/docio","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/IoLanguage%2Fdocio","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IoLanguage%2Fdocio/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IoLanguage%2Fdocio/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IoLanguage%2Fdocio/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/IoLanguage","download_url":"https://codeload.github.com/IoLanguage/docio/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243532525,"owners_count":20306152,"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":["docs","documentation","documentation-generator","io","site-generator","static-site-generator"],"created_at":"2024-11-19T21:21:06.768Z","updated_at":"2025-03-14T05:44:51.460Z","avatar_url":"https://github.com/IoLanguage.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"Docio\n=====\n\nDocumentation generator for [Eerie](https://github.com/AlesTsurko/eerie)\npackages. \n\n\n\n\n## Install\n\nDocio ships with Eerie by default. If you've installed\n[Eerie](https://github.com/AlesTsurko/eerie) you already have Docio.\n\n\n\n\n## Usage\n\nFor the API documentation and guide check Docio's site (which is also an example\nof generated output): http://iolanguage.github.io/docio\n\n\n### CLI\n\n```\ndocio package=/path/to/package [template=/path/to/template]\n```\n\nThis command recursively searches for files with extensions \"io\", \"docio\", \"c\"\nand \"m\" in the `source` and `io` directories. Then it extracts documentation\nfrom theses files and compiles HTML using either the provided or default\ntemplate. After that it put all the documentation in `docs` folder in the\npackage directory.\n\n\n### Documentation Comments Format\n\nYou need to add your object to a category first. The category can be named\nwhatever you like. You'll get more understanding of what is a category, when you\ngenerate your docs. So just try it and see.\n\n```Io\n//metadoc Prototype category API\n```\n\nOptionally add a description to the object:\n\n```Io\n/*metadoc Prototype description\nDesciption goes here.\n*/\n```\n\nThen comment out your public API like this:\n```Io\n//doc Prototype slotName(args) Description\n```\n\nMarkdown is fully supported.\n\n\n### Writing Templates\n\nYou should provide two template files: `main_template.html` and\n`prototype_template.html`. The first one is used to generate the main page. The\nsecond is for the documentation pages.\n\nIn the template files you can use Io code:\n\n```Io\n\u003ch1\u003e#{\"Hello\"}\u003c/h1\u003e\n```\n\nCheck out `template` folder to get an example.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiolanguage%2Fdocio","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fiolanguage%2Fdocio","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiolanguage%2Fdocio/lists"}