{"id":22423294,"url":"https://github.com/prantlf/grunt-mdoc","last_synced_at":"2025-03-27T05:40:33.473Z","repository":{"id":26585633,"uuid":"30040187","full_name":"prantlf/grunt-mdoc","owner":"prantlf","description":"Grunt plugin generating HTML documentation from Markdown sources using mdoc","archived":false,"fork":false,"pushed_at":"2019-12-27T12:46:05.000Z","size":200,"stargazers_count":1,"open_issues_count":1,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-06T05:37:39.678Z","etag":null,"topics":["documentation-generator","grunt-plugins","mdoc"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/prantlf.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}},"created_at":"2015-01-29T20:40:17.000Z","updated_at":"2019-09-24T06:56:11.000Z","dependencies_parsed_at":"2022-09-04T14:53:38.987Z","dependency_job_id":null,"html_url":"https://github.com/prantlf/grunt-mdoc","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prantlf%2Fgrunt-mdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prantlf%2Fgrunt-mdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prantlf%2Fgrunt-mdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prantlf%2Fgrunt-mdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/prantlf","download_url":"https://codeload.github.com/prantlf/grunt-mdoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245791897,"owners_count":20672667,"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":["documentation-generator","grunt-plugins","mdoc"],"created_at":"2024-12-05T18:09:55.015Z","updated_at":"2025-03-27T05:40:33.454Z","avatar_url":"https://github.com/prantlf.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# grunt-mdoc\n[![NPM version](https://badge.fury.io/js/grunt-mdoc.png)](http://badge.fury.io/js/grunt-mdoc)\n[![Build Status](https://travis-ci.org/prantlf/grunt-mdoc.png)](https://travis-ci.org/prantlf/grunt-mdoc)\n[![Coverage Status](https://coveralls.io/repos/prantlf/grunt-mdoc/badge.svg)](https://coveralls.io/r/prantlf/grunt-mdoc)\n[![Dependency Status](https://david-dm.org/prantlf/grunt-mdoc.svg)](https://david-dm.org/prantlf/grunt-mdoc)\n[![devDependency Status](https://david-dm.org/prantlf/grunt-mdoc/dev-status.svg)](https://david-dm.org/prantlf/grunt-mdoc#info=devDependencies)\n[![devDependency Status](https://david-dm.org/prantlf/grunt-mdoc/peer-status.svg)](https://david-dm.org/prantlf/grunt-mdoc#info=peerDependencies)\n[![Code Climate](https://codeclimate.com/github/prantlf/grunt-mdoc/badges/gpa.svg)](https://codeclimate.com/github/prantlf/grunt-mdoc)\n[![Codacy Badge](https://www.codacy.com/project/badge/f3896e8dfa5342b8add12d50390edfcd)](https://www.codacy.com/public/prantlf/grunt-mdoc)\n[![Built with Grunt](https://cdn.gruntjs.com/builtwith.png)](http://gruntjs.com/)\n\n[![NPM Downloads](https://nodei.co/npm/grunt-mdoc.png?downloads=true\u0026stars=true)](https://www.npmjs.com/package/grunt-mdoc)\n\nThis module provides a grunt multi-task generating HTML documentation from\nMarkdown sources using [mdoc].\n\n## Installation\n\nYou need [node \u003e= 0.10][node], [npm] and [grunt \u003e= 0.4][Grunt] installed\nand your project build managed by a [Gruntfile] with the necessary modules\nlisted in [package.json].  If you haven't used Grunt before, be sure to\ncheck out the [Getting Started] guide, as it explains how to create a\nGruntfile as well as install and use Grunt plugins.  Once you're familiar\nwith that process, you may install this plugin with this command:\n\n```shell\n$ npm install grunt-mdoc --save-dev\n```\n\n## Input\n\nStore your written articles in to a folder (input), specify a target folder\nfor the generated HTML pages and optionally a title page (index.md):\n\n```text\ninput/\n  overview.md\n  ...\noutput/\n assets_/\n index.html\n overview.html\n ...\nindex.md\nGruntfile.js\n```\n\n## Configuration\n\nAdd the `mdoc` entry with the mdoc task configuration to the options of the\n`grunt.initConfig` method:\n\n```js\ngrunt.initConfig({\n  mdoc: {\n    dist: {\n      src: 'input',\n      dest: 'output',\n      options: {\n        indexContentPath: 'index.md',\n        baseTitle: 'My Project Documentation'\n      }\n    }\n  }\n});\n```\n\nThe supported options are:\n\n * `src` : (required) the source folder with files in the Markdown\n           format; sub-folders will be searched recursively\n * `dest` : (required) the target folder for the HTML files\n * `indexContent`: (optional) HTML markup to put to the top of the index\n                   page; it takes precedence over `indexContentPath`\n * `indexContentPath` : (optional) Markdown source file for the index page\n * `baseTitle` : (optional) the title text for the HTML page head\n * ... refer to the [mdoc] documentation for all the available options\n\nThen, load the plugin:\n\n```javascript\ngrunt.loadNpmTasks('grunt-mdoc');\n```\n\n## Build\n\nCall the `mdoc` task:\n\n```shell\n$ grunt mdoc\n```\n\nor integrate it to your build sequence in `Gruntfile.js`:\n\n```js\ngrunt.registerTask('default', ['mdoc', ...]);\n```\n\n## Notes\n\nThe generated `index.html` file should be opened from a HTTP server.  The\nsidebar that shows the documentation index is loaded by AJAX, which does\nnot work when the HTML page is opened from the `file://` scheme.\n\n## Contributing\n\nIn lieu of a formal styleguide, take care to maintain the existing coding\nstyle.  Add unit tests for any new or changed functionality. Lint and test\nyour code using Grunt.\n\n## Release History\n\n * 2018-04-27   v1.0.0   Dropped support of Node.js 4\n * 2017-02-24   v0.3.1   Update dependencies\n * 2016-26-08   v0.3.0   Upgrade to Grunt 1.x\n * 2016-03-05   v0.2.2   Update dependencies, improve build testing\n * 2015-01-31   v0.1.1   Initial release\n\n## License\n\nCopyright (c) 2015-2019 Ferdinand Prantl\n\nLicensed under the MIT license.\n\n[node]: http://nodejs.org\n[npm]: http://npmjs.org\n[package.json]: https://docs.npmjs.com/files/package.json\n[Grunt]: https://gruntjs.com\n[Gruntfile]: http://gruntjs.com/sample-gruntfile\n[Getting Gtarted]: https://github.com/gruntjs/grunt/wiki/Getting-started\n[mdoc]: https://github.com/millermedeiros/mdoc\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprantlf%2Fgrunt-mdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprantlf%2Fgrunt-mdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprantlf%2Fgrunt-mdoc/lists"}