{"_rev":"3-fb0a96169f18d99dee2e97d4f2ae5fd5","time":{"created":"2022-10-19T16:33:57.867Z","1.8.0":"2022-10-19T15:58:00.315Z","modified":"2022-10-19T16:33:58.238Z","1.8.1":"2022-10-19T16:33:58.108Z"},"_id":"@deoxys-1/md-to-site","name":"@deoxys-1/md-to-site","dist-tags":{"latest":"1.8.1"},"versions":{"1.8.1":{"name":"@deoxys-1/md-to-site","version":"1.8.1","description":"Create a static HTML website from a folder containing markdown files.","license":"MIT","author":{"name":"Giovan Angela","email":"deoxys@github.com"},"main":"index.js","type":"module","scripts":{"test":"echo \"Error: no test specified\"","watch":"sass ./assets/layouts/default/style.scss ./assets/layouts/default/dist/css/style.css --watch --style=compressed","compile":"sass ./assets/layouts/default/style.scss ./assets/css/style.css --style=compressed"},"repository":{"type":"git","url":"git+https://github.com/danielefavi/md-to-site.git"},"homepage":"https://github.com/danielefavi/md-to-site#readme","keywords":["markdown","markup","md","html","static","site","directory","folder"],"bin":{"md-to-site":"cli.js"},"dependencies":{"marked":"^4.1.1","node-sass":"npm:sass@^1.55.0","striptags":"^3.1.1","yargs":"^17.6.0"},"gitHead":"46148012412486f5d0948b11bbe7d3a88709693c","bugs":{"url":"https://github.com/danielefavi/md-to-site/issues"},"_id":"@deoxys-1/md-to-site@1.8.1","_nodeVersion":"18.10.0","_npmVersion":"8.19.2","dist":{"integrity":"sha512-zgaoH2v2LIsneN+TfbmAupyhjkPJSMrKaLl4+S7cJv2IzuYU0wKXXEL8ACvXK8SgDikqLsPR2Xr/w3AtDQIGZQ==","shasum":"275e0c5aa37ad19752b377b5e2ba115a824fc8c2","tarball":"https://registry.npmjs.org/@deoxys-1/md-to-site/-/md-to-site-1.8.1.tgz","fileCount":33,"unpackedSize":250311,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCgQ/Cy3VFD8cKW0v3Z9tiPCgro8SY/ddrB7xApUz7x9gIgbBde8Iq5kzIjwbPKua8G+DwyywsUdxgvlquao+OXyWE="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjUCb2ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoEOQ/8CUARy+lN6XNZfiuRbxUhEkX+rV0VIfOHgbUKZJIqITuiFDf4\r\nXpU11xg8KkzLvPzkwEjm/qnv8w413pSqTY+uEau6e+FHpmWGgQZc0IoXHGq4\r\npAfQ5tNoL3HDyhgEqywWJXKcIG1mLN6ZYBBr3zBnVqYp9SkthcqFwkwLeEj3\r\nUQKL7nQwzrs+ri9Vs7k8v4VMg2xT1mqmC8O3nOXSql413S87Nsyb8CBrsMui\r\nhfJSmBzekf1lvANHiuVYTFqg6THqkH+Qls5r633Df7ibxB4TR4a4UNqSW+SX\r\nlsfv9xZWKnM5AQy6bN7oUb43ytIEGLbIZnJrbZzwABYRy3nLR+hhg4/hjm/W\r\nL1SLExfy8+rp9+g6z3o2Jk0DS2AAJvhVLPxCyFQvCW+9X7PiDf2bu7+xDxix\r\n62Cxy6+m3EXZqFPU6GFIP1fLcw9B+AuSyV5XdvbUq7+JpnnWVSjRzuQBTrfo\r\nqXZqhP6hIdZu+xSp33VXJ14FOEVU4BAO3kEXprnhBqDZX+W5DP658U4aTB7e\r\nZNAFXhrYTTDHUqafBFEDPByY0Y19QUqLwTQBaUntbdLb1wziwdFFK3ZHKGwZ\r\nlROGtUxYZNQ/a35VydDa30vK7RH4j+47XSceRYCn2okT9xvKTa5ClOOr8vXk\r\ncxx0Ri0ycWZjaVhDZy+aJX5NFyDhhY3+UzU=\r\n=w8BU\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"deoxys-1","email":"giovan.angela@gmail.com"},"directories":{},"maintainers":[{"name":"deoxys-1","email":"giovan.angela@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/md-to-site_1.8.1_1666197237919_0.5485454555909799"},"_hasShrinkwrap":false}},"maintainers":[{"name":"deoxys-1","email":"giovan.angela@gmail.com"}],"description":"Create a static HTML website from a folder containing markdown files.","homepage":"https://github.com/danielefavi/md-to-site#readme","keywords":["markdown","markup","md","html","static","site","directory","folder"],"repository":{"type":"git","url":"git+https://github.com/danielefavi/md-to-site.git"},"author":{"name":"Giovan Angela","email":"deoxys@github.com"},"bugs":{"url":"https://github.com/danielefavi/md-to-site/issues"},"license":"MIT","readme":"Markdown to Site\n================\n\nThis is a continuation of the tool originally created by danielefavi whose code can be found [here](https://github.com/danielefavi/md-to-site)\n\n**Markdown to Site** is a NPM package that converts a folder containing markdown files to a static website.\n\nIt automatically creates the **menu**, **search engine** and the **table of contents**. If there are **subfolders** with markdown files it will create the **submenus** accordingly.\n\n\n\n# Installation\nTODO: upload to npmjs\n\n```\nnpm install -g @deoxys-1/md-to-site\n```\n\n# How to convert markdown files to a website\n\nRun the command below in the directory that contains your markdown files:\n\n```\nmd-to-site build\n```\n\nIt creates a new folder called `build` that will contains the HTML website.\n\nOptionally, you can specify a source folder and/or a target folder:\n\n```\nmd-to-site build ~/Desktop/markdown ~/Desktop/docs_site\n```\n\nFor more information please type `md-to-site -h` for the help.\n\n---\n\n### Notes\n\nIf you have images or other assets in your markdown folder, then you have to transfer them manually into the folder where you compiled the files.  \nThe author of this package did not want to copy other asset files automatically because you might not want to copy personal files.\n\n# List of Parameters\n\n```\nUsage: md-to-site <command> [options]\n\nCommands:\n  md-to-site build <source> <target>  Builds the website from the markdown code.\n\nOptions:\n  --help     Show help                                                 [boolean]\n  --version  Show version number                                       [boolean]\n  \n```\n\n```\nmd-to-site build <source> <target>\n\nBuilds the website from the markdown code.\n\nPositionals:\n  source  Directory of the source folder containing the markdown files.\n                                                             [string] [required]\n  target  Directory where the compiled HTML are going to be stored.\n                                                             [string] [required]\n\nOptions:\n      --help        Show help                                          [boolean]\n      --version     Show version number                                [boolean]\n  -i, --include     Include only the paths that match the given regex string.\n                                                                        [string]\n  -e, --exclude     Exclude the paths that match the given regex string.[string]\n  -n, --index       File name that will be set as index.html. By default is READ\n                    ME.md; if there is no README.md then it will be the first oc\n                    currence.                                           [string]\n  -t, --site-title  Title of the website: it will appear on the title tag and on\n                     top of the menu.                                   [string]\n      --hide        Hide the functionalities or part of the website. Insert the\n                    list of items to hide comma separated. Possible values: sear\n                    ch, toc.                                            [string]\n                    \n```\n\n# Docker\nTo build the image run the following command in the root of this source folder:\n```\ndocker build --tag md-to-site ./\n```\n\nTo run the container run the following command:\n```\ndocker run -v [Path to input folder]:/in -v [Path to output folder]:/out --rm md-to-site build /in /out\n```\n\nFor example:\n```\ndocker run -v $PWD/pagebuilder:/in -v $PWD/pagebuilder/out:/out --rm md-to-site build /in /out\n```\n\nOr just pull the image directly from Docker Hub without building:\n```\ndocker run --rm deoxys/md-to-site\n```\n","readmeFilename":"README.md"}