{"_id":"@aquilinedrones/ad-docs","_rev":"2-620474ab32d881165e33da513be3bf22","name":"@aquilinedrones/ad-docs","dist-tags":{"latest":"2.0.1"},"versions":{"2.0.1":{"name":"@aquilinedrones/ad-docs","version":"2.0.1","main":"./src/index.js","author":{"name":"aquilinedrones"},"license":"MIT","bin":{"addocs":"bin/cli.js"},"scripts":{"start":"node src/index.js -- -c ./__tests__/sandbox/config.js","dev":"nodemon src/index.js -- -c ./__tests__/sandbox/config.js","lint":"eslint --fix --cache src","pub":"bash etc/publish.sh","test":"bash __tests__/run.sh"},"lint-staged":{"*.js":["eslint --fix src"]},"husky":{"hooks":{"pre-commit":"eslint --fix --cache src","prepare-commit-msg":"exec < /dev/tty && git cz --hook || true"}},"dependencies":{"browser-sync":"^2.26.14","commander":"^7.2.0","glob":"^7.2.0","gulp":"^4.0.2","gulp-clean":"^0.4.0","gulp-plumber":"^1.2.1","gulp-sass":"^5.0.0","marked":"^2.0.1","multipipe":"^4.0.0","npm":"^7.6.3","plugin-error":"^1.0.1","sass":"^1.42.1","through2":"^4.0.2"},"devDependencies":{"@aquiline/eslint-config-node":"https://code.aquilinedrones.com/AquilineDrones/eslint-config-node.git#1.0.1","commitizen":"^4.2.1","cz-conventional-changelog":"3.3.0","husky":"^4.2.5","jest":"^27.2.0","lint-staged":"^10.2.11","nodemon":"^2.0.13"},"config":{"commitizen":{"path":"./node_modules/cz-conventional-changelog"}},"gitHead":"5a9dc455de54cca4c6e3b8825ffec544d388ecb1","description":"A cli to transform markdown to html","_id":"@aquilinedrones/ad-docs@2.0.1","_nodeVersion":"12.16.2","_npmVersion":"6.14.4","dist":{"integrity":"sha512-y5bZR1oG7oVE8p15/Bn/M/+TIZ1IN5Jf2obYQSTUYGq8RBVyuLR0duMRGtXY3hiYMz50a+MBfXhq58UkqgZb0w==","shasum":"18cda06a86157c8e71eb29cc65edf075a9c699b4","tarball":"https://registry.npmjs.org/@aquilinedrones/ad-docs/-/ad-docs-2.0.1.tgz","fileCount":35,"unpackedSize":23338,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhwy4kCRA9TVsSAnZWagAAc0EP/0FA3S6NB8pQaJ20ymDl\nGUExPuEJ6MJuvKlLEjbae9ShRC3QtO4oeftwVWdeeIKvPTSxbnkFGESeH1rw\nxbbW0yrftdZZbFLLRNYSiRtTi9X3RqDmJfckBZLZLrznNNOnE5w8odpfHAl/\ni2Nd0Cpu289QX3M4rx4SFgBKyTE6j1H4p/9VUk59JvCP72GWorJbb7cQQze7\n8+EqvffDfY/Jdt+dEm3DjxrZSbpUhpMkfvhM9fPqMBNE8aY59hTzZhNKMPQI\n12Lhpqkw9CfPtlsW2FX9D65X5s+IvLi+Q+9UkOV8iS/LrbrQ9NQ84P9SkorE\nl/QIxmYAha93mrOLqFT1S3ToiW25YJ+YNgpqSsXW4yfSvkISWJiykyvxmkGg\nKp3o7752mJaAH3cOVxMTWci7ph5QGN0zqxsVGLkISD2CRdq0d7sLb3Q80mSb\nAJHOooKTdW4ukjTha1U16if3Nbrefls5ZgyS2BRw9ospxB8jAptDY5H5j2rt\n/VUe0AM8iro6CmpuVL3ukSNXwryJNpcw2OjF129/bX+ZgUXEe6LIXvOptnol\nDCtrbLRZITW5xGsuXFsXZE6MLV7WyWioFPa8ST2zDiSxYdljDdqMwUSyezdx\nx6svEU3LZVVZeHIajlA1BbFSSlLfty0WT1naaaxDXbXU6AvGKBdoLR7l5fm4\n+OAs\r\n=UDrX\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCID3AqLnhHoczBuuNnwLHzqvb1EDkyVSlAKfJdyRYpfdBAiEArufde8EwuAaXVz80z/3uPrK7YmEkyuWeLSsQ5A0fGBA="}]},"_npmUser":{"name":"aquilinedrones","email":"devteam@aquilinedrones.com"},"directories":{},"maintainers":[{"name":"aquilinedrones","email":"devteam@aquilinedrones.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ad-docs_2.0.1_1632704533300_0.13875816177361"},"_hasShrinkwrap":false}},"time":{"created":"2021-09-27T01:02:13.253Z","2.0.1":"2021-09-27T01:02:13.446Z","modified":"2022-04-04T15:14:08.047Z"},"maintainers":[{"name":"aquilinedrones","email":"devteam@aquilinedrones.com"}],"description":"A cli to transform markdown to html","author":{"name":"aquilinedrones"},"license":"MIT","readme":"# ad-docs\n\nA cli to transform markdown to html\n\n---\n\n## install\n\n```bash\nnpm i ad-docs --save-dev\n```\nor\n\n```bash\nyarn add ad-docs -D\n```\n\n---\n\n## usage\n\n```bash\nnpx ad-docs -h\n\nUsage: cli [options]\n\nOptions:\n  -o --out <path>  path where save the html (default: \"/dist\")\n  --cwd <path>     current working directory\n  run              run on browser\n  -V, --version    output the version number\n  -h, --help       display help for command\n```\n\n* __cwd__ current working directory, default is where you run `npx ad-docs` command\n* __out__ path of the output html file, it will use `cwd` as base path\n\n---\n\n## Example\n\n```bash\nnpx ad-docs\n```\nAbove command will transform all .md files to .html from current directory to dist\n\n```bash\nnpx ad-docs run\n```\nAbove command will run all .html files and open browser\n\n---\n\n## deps\n\n* [commander](https://github.com/tj/commander.js)\n\n* [gulp](https://github.com/gulpjs/gulp)\n\n* [gulp docs](https://gulpjs.com/docs/en/getting-started/quick-start/)\n\n* [vinyl files](https://gulpjs.com/docs/en/api/vinyl)\n\n* [gulp-plumber](https://github.com/floatdrop/gulp-plumber)\n\n  predictable stream error management\n\n* [browser sync](https://browsersync.io/docs/gulp)\n\n* [gulp sass](https://github.com/dlmanning/gulp-sass)\n\n* [dart-sass](https://www.npmjs.com/package/sass)\n\n* [gulp-markdown](https://github.com/sindresorhus/gulp-markdown)\n\n* [marked](https://github.com/markedjs/marked/)\n\n* [marked options](https://marked.js.org/using_advanced#options)\n\n* [markdown-it, alternative to marked](https://github.com/markdown-it/markdown-it)\n\n* [glob](https://github.com/isaacs/node-glob)\n\n* [multipipe](https://www.npmjs.com/package/multipipe)\n\n  this one allows for grouping of pipe streams for DRY\n\n---\n\n## publish\n\n* [npm docs](https://docs.npmjs.com/cli/v7/using-npm/developers)\n\nThis module is made available on npm as `ad-docs`.\n\nmaintainer: `aquilinedrones`\n\n* with username/password\n```\n  npm login\n  npm publish\n```\n\n* with automation token\n```\n  export NPM_TOKEN=\"<your token here>\"\n  yarn publish\n```\n\n* why is the `.npmrc` file not on the root of the project?\n\nSince the file requires an env var, `NPM_TOKEN`, if that is not declared on the shell session, any `npm` or `yarn` command will actually fail, which is not a good dev UX.\n\n---\n\n## License\n\n[MIT](LICENSE)\n","readmeFilename":"README.md"}