{"id":19356339,"url":"https://github.com/falinor/vue-markdown-routing","last_synced_at":"2026-04-07T08:32:20.227Z","repository":{"id":106158853,"uuid":"259576511","full_name":"Falinor/vue-markdown-routing","owner":"Falinor","description":"Generate Vue Router routes automatically using a markdown arborescence.","archived":false,"fork":false,"pushed_at":"2020-08-01T22:37:40.000Z","size":958,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-06T20:07:16.108Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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/Falinor.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":"2020-04-28T08:26:38.000Z","updated_at":"2022-08-19T02:38:15.000Z","dependencies_parsed_at":null,"dependency_job_id":"2290d2b6-0979-4eae-be6c-ed1664f425d3","html_url":"https://github.com/Falinor/vue-markdown-routing","commit_stats":{"total_commits":114,"total_committers":4,"mean_commits":28.5,"dds":"0.29824561403508776","last_synced_commit":"3a7bff5ccd1a10ff192b4e07d77d6824ba4521e3"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Falinor%2Fvue-markdown-routing","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Falinor%2Fvue-markdown-routing/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Falinor%2Fvue-markdown-routing/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Falinor%2Fvue-markdown-routing/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Falinor","download_url":"https://codeload.github.com/Falinor/vue-markdown-routing/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240468846,"owners_count":19806265,"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-10T07:04:04.955Z","updated_at":"2026-04-07T08:32:20.173Z","avatar_url":"https://github.com/Falinor.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# vue-markdown-routing\n\nGenerate Vue Router routing automatically.\n\n## Installation\n\n```bash\n$ npm install -D vue-markdown-routing\n```\n\n## Requirements\n\n- webpack \u003e= v4.0.0\n\n## Usage\n\nTo use this, you import `vue-markdown-routing` and pass it into Vue Router constructor options.\n\n```js\n// Import generated routes\nimport routes from 'vue-md-auto-routing'\n\nimport Vue from 'vue'\nimport Router from 'vue-router'\n\nVue.use(Router)\n\nexport default new Router({\n  // Pass the generated routes into the routes option\n  routes\n})\n```\n\nYou also need to add a webpack plugin vue-auto-routing provides. The plugin options are the same as [vue-route-generator options](https://github.com/ktsn/vue-route-generator#references)\n\n```js\n// webpack.config.js\nconst path = require('path')\nconst VueAutoRoutingPlugin = require('vue-auto-routing/lib/webpack-plugin')\n\nmodule.exports = {\n  // ... other options ...\n\n  plugins: [\n    new VueAutoRoutingPlugin({\n      // Directories to load markdown assets from\n      folders: [\n        path.resolve(__dirname, 'src', 'assets', 'guides'),\n        path.resolve(__dirname, 'src', 'assets', 'articles')\n      ],\n      // A string that will be added to importing component path (defaults to @/assets/).\n      importPrefix: '@/assets/'\n    })\n  ]\n}\n```\n\n## Related Projects\n\n* [vue-md-route-generator](https://github.com/Falinor/vue-md-route-generator): Low-level utility generating routes based on a markdown arborescence.\n\n## License\n\nMIT\n\n## Thanks\n\nThanks to [ktsn](https://github.com/ktsn) for the initial code!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffalinor%2Fvue-markdown-routing","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffalinor%2Fvue-markdown-routing","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffalinor%2Fvue-markdown-routing/lists"}