{"id":13876172,"url":"https://github.com/josemarluedke/docfy","last_synced_at":"2025-04-07T18:15:21.623Z","repository":{"id":40399692,"uuid":"254531229","full_name":"josemarluedke/docfy","owner":"josemarluedke","description":"Build fully personalized documentation sites; write content and demos in Markdown.","archived":false,"fork":false,"pushed_at":"2024-02-19T18:55:41.000Z","size":4218,"stargazers_count":74,"open_issues_count":33,"forks_count":26,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-04-06T07:10:01.872Z","etag":null,"topics":["docs","documentation-builder","ember","ember-addon","emberjs","javascript","site-builder","typescript"],"latest_commit_sha":null,"homepage":"https://docfy.dev","language":"TypeScript","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/josemarluedke.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","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":"2020-04-10T03:02:54.000Z","updated_at":"2024-12-14T15:36:08.000Z","dependencies_parsed_at":"2024-01-13T19:47:17.487Z","dependency_job_id":"086eb459-3b26-4e51-bc8b-b7d70fa0b37e","html_url":"https://github.com/josemarluedke/docfy","commit_stats":{"total_commits":321,"total_committers":10,"mean_commits":32.1,"dds":0.161993769470405,"last_synced_commit":"3745bd3c8c45202a0c11d8fd502b52a5e3f62493"},"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/josemarluedke%2Fdocfy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/josemarluedke%2Fdocfy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/josemarluedke%2Fdocfy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/josemarluedke%2Fdocfy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/josemarluedke","download_url":"https://codeload.github.com/josemarluedke/docfy/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247704571,"owners_count":20982298,"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-builder","ember","ember-addon","emberjs","javascript","site-builder","typescript"],"created_at":"2024-08-06T06:01:05.857Z","updated_at":"2025-04-07T18:15:21.591Z","avatar_url":"https://github.com/josemarluedke.png","language":"TypeScript","funding_links":[],"categories":["TypeScript","typescript"],"sub_categories":[],"readme":"\u003cimg width=\"978\" alt=\"Docfy Logo\" src=\"https://repository-images.githubusercontent.com/254531229/d6e4fc80-5efd-11eb-9c08-99fd3d8bce07\"\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/josemarluedke/docfy/actions?query=workflow%3ACI\"\u003e\u003cimg src=\"https://github.com/josemarluedke/docfy/workflows/CI/badge.svg\" alt=\"Build Status\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/josemarluedke/docfy/blob/main/LICENSE.md\"\u003e\u003cimg src=\"https://img.shields.io/badge/license-MIT-blue.svg\" alt=\"GitHub license\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\nDocfy is a modular JavaScript tool to help build documentation sites. Its core\nhas all the essential features to help you create a full-featured docs app while\nwriting all your content in Markdown.\n\n## Documentation\n\nVisit [docfy.dev](https://docfy.dev/) to read the docs and see live demos.\n\n## Usage\n\n### Core\n\nThe example below uses TypeScript.\n\n```ts\nimport Docfy from '@docfy/core';\nimport path from 'path';\nimport hbs from 'remark-hbs';\nimport autolinkHeadings from 'remark-autolink-headings';\n\nconst projectRoot = '../tests/__fixtures__/monorepo/';\nconst root = path.resolve(__dirname, projectRoot);\n\n(async function (): Promise\u003cvoid\u003e {\n  const docfy = new Docfy({\n    remarkPlugins: [[autolinkHeadings, { behavior: 'append' }], hbs]\n  });\n\n  const docs = await docfy.run([\n    {\n      root,\n      urlPrefix: 'docs',\n      urlSchema: 'manual',\n      pattern: '**/*.md'\n    }\n  ]);\n\n  console.log(docs);\n})();\n```\n\n## Compatibility\n\n- Node.js v12 or above\n\n## License\n\nThis project is licensed under the [MIT License](LICENSE.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjosemarluedke%2Fdocfy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjosemarluedke%2Fdocfy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjosemarluedke%2Fdocfy/lists"}