{"id":20438434,"url":"https://github.com/tinymce/moxiedoc","last_synced_at":"2025-04-12T22:35:50.340Z","repository":{"id":37939363,"uuid":"47156942","full_name":"tinymce/moxiedoc","owner":"tinymce","description":"TinyMCE website documentation","archived":false,"fork":false,"pushed_at":"2024-02-27T16:34:54.000Z","size":828,"stargazers_count":2,"open_issues_count":3,"forks_count":3,"subscribers_count":7,"default_branch":"main","last_synced_at":"2024-04-28T08:41:33.813Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":false,"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/tinymce.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-12-01T01:23:26.000Z","updated_at":"2024-06-19T15:09:38.519Z","dependencies_parsed_at":"2024-06-19T15:23:15.458Z","dependency_job_id":null,"html_url":"https://github.com/tinymce/moxiedoc","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tinymce%2Fmoxiedoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tinymce%2Fmoxiedoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tinymce%2Fmoxiedoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tinymce%2Fmoxiedoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tinymce","download_url":"https://codeload.github.com/tinymce/moxiedoc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248642564,"owners_count":21138351,"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-11-15T09:11:01.960Z","updated_at":"2025-04-12T22:35:50.316Z","avatar_url":"https://github.com/tinymce.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# moxiedoc\n\n## Introduction\n\nThis project maintains Moxiedoc, a tool used to build API reference documentation. If you have any modifications you wish to contribute, fork this project, make the changes and submit a pull request. You will need to sign the contributors license agreement, which will be emailed to you upon creating the pull request.\n\n## Using Moxiedoc\n\nTo create API reference documentation from a development version of moxiedoc, run:\n\n```\nyarn build\nnode ./dist/lib/cli.js PATH/TO/API_FILE_FOLDER\n```\n\n## Moxiedoc Options\n\nMoxiedoc provides the following options to customise the format of the output documentation:\n\n```\n-o --out \u003cpath\u003e: location of output files, default: 'tmp/out.zip'\n-t --template \u003ctemplate\u003e: documentation type: default: 'cli'; 'antora', 'github', 'moxiewiki', 'singlehtml', 'tinymcenext', 'xml'\n-s --structure \u003ctype\u003e: default: 'default'; 'legacy'\n-v --verbose: verbose output\n--debug: debug output\n--dry: dry run only syntax check\n--fail-on-warning: fail if warnings are produced\n```\n\n## Schema\n\nThe output JSON takes the form of the following schema:\n\n```json\n{\n  \"namespace.Class\": {\n    \"type\": \"class|enum|struct|mixin|interface\",\n    \"members\": [\n      {\n        \"type\": \"method|field|property|event|constant|callback\",\n        \"static\": true,\n        \"abstract\": true,\n        \"name\": \"doStuff\",\n        \"access\": \"private|protected|internal|public\",\n        \"extends\": \"namespace.Class\",\n        \"implements\": [\"namespace.Interface\"],\n        \"deprecated\": \"Text about deprecation\",\n        \"description\": \"Do stuff\",\n        \"mixes\": [\"namespace.Class1\", \"namespace.Class2\"],\n        \"examples\": [\n          {\"text\": \"Some example\"},\n          {\"caption\": \"Some example\", \"text\": \"Some example\"}\n        ],\n        \"params\": [\n          {\"name\": \"mystuff\", \"type\": \"string\", \"description\": \"My stuff\"}\n        ],\n        \"returns\": {\n          {\"type\": \"string\", \"description\": \"Returns string.\"}\n        }\n      }\n    ]\n  }\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftinymce%2Fmoxiedoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftinymce%2Fmoxiedoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftinymce%2Fmoxiedoc/lists"}