{"_id":"@barkleyrei/doc-site","_rev":"7-5d77fbf7695e0174f04d4eed33df958a","name":"@barkleyrei/doc-site","dist-tags":{"latest":"0.1.7"},"versions":{"0.1.0":{"name":"@barkleyrei/doc-site","version":"0.1.0","author":"","license":"MIT","_id":"@barkleyrei/doc-site@0.1.0","maintainers":[{"name":"dwhitebr31","email":"dwhite@barkleyus.com"},{"name":"tyllyn","email":"joshie@gmail.com"},{"name":"bzungali","email":"bzungali@barkleyus.com"},{"name":"sswackhammer","email":"sswackhammer@barkleyus.com"}],"bin":{"dsb":"bin/dsb-build","dsb-init":"bin/dsb-init","dsb-build":"bin/dsb-build","dsb-serve":"bin/dsb-serve"},"dist":{"shasum":"071d02874c902b8887e91a1515d264a6a4fad41e","tarball":"https://registry.npmjs.org/@barkleyrei/doc-site/-/doc-site-0.1.0.tgz","fileCount":14,"integrity":"sha512-GBJSyy020cB9HmK4Xwt/8G7e8xmzF7P6hejPoZkuvTgEe/HNMCiwPhXJXUFmG9OWa0Nk+c+Y21Eqn5zGDFLauQ==","signatures":[{"sig":"MEUCIQC7Vg+d+2jTd6dEtd59RfMPPbClR2HSGbgexwCzhWVNmQIgCbsgqhn+X1rP1erSHZOjX2RSj58beami07m8iHkFjuI=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":17107},"main":"index.js","gitHead":"c905fb6e458f4480ba184c1f542611ac81e3be67","scripts":{"test":"echo \"Error: no test specified\" && exit 1","doc-site-build":"node index.js"},"_npmUser":{"name":"tyllyn","email":"joshie@gmail.com"},"_npmVersion":"10.9.0","description":"Templated builds for documentation sites.","directories":{},"_nodeVersion":"21.6.1","dependencies":{"shelljs":"^0.8.5","docsify-cli":"^4.4.4"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/doc-site_0.1.0_1734395079775_0.0241227028379829","host":"s3://npm-registry-packages-npm-production"}},"0.1.1":{"name":"@barkleyrei/doc-site","version":"0.1.1","author":"","license":"MIT","_id":"@barkleyrei/doc-site@0.1.1","maintainers":[{"name":"dwhitebr31","email":"dwhite@barkleyus.com"},{"name":"tyllyn","email":"joshie@gmail.com"},{"name":"bzungali","email":"bzungali@barkleyus.com"},{"name":"sswackhammer","email":"sswackhammer@barkleyus.com"}],"bin":{"dsb":"bin/dsb-build","dsb-ghw":"bin/dsb-github-workflow","dsb-init":"bin/dsb-init","dsb-build":"bin/dsb-build","dsb-serve":"bin/dsb-serve"},"dist":{"shasum":"2e918b550eb9e6ca21d6cf9f763c02b5d0d1630a","tarball":"https://registry.npmjs.org/@barkleyrei/doc-site/-/doc-site-0.1.1.tgz","fileCount":16,"integrity":"sha512-KL7UhJ1z4IJX8UN7NwhClpn2yVD3vaY1Bs90oXtEjHYslglVBTg1NqDlJamZupB+UMJBp2MBsNOHo0+R7LTwvw==","signatures":[{"sig":"MEQCIF3fTiJRkaAlcFloYtexr6AxkqBL/zPKqjF+FFeuzxE2AiAqUoj2divqjcvbA60YQjAa25CMgCVH3/BWsFw8qnA2oQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":18884},"main":"index.js","gitHead":"c905fb6e458f4480ba184c1f542611ac81e3be67","scripts":{"test":"echo \"Error: no test specified\" && exit 1","doc-site-build":"node index.js"},"_npmUser":{"name":"tyllyn","email":"joshie@gmail.com"},"_npmVersion":"10.9.0","description":"Templated builds for documentation sites.","directories":{},"_nodeVersion":"21.6.1","dependencies":{"shelljs":"^0.8.5","docsify-cli":"^4.4.4"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/doc-site_0.1.1_1734395851293_0.4148910550908991","host":"s3://npm-registry-packages-npm-production"}},"0.1.2":{"name":"@barkleyrei/doc-site","version":"0.1.2","author":"","license":"MIT","_id":"@barkleyrei/doc-site@0.1.2","maintainers":[{"name":"dwhitebr31","email":"dwhite@barkleyus.com"},{"name":"tyllyn","email":"joshie@gmail.com"},{"name":"bzungali","email":"bzungali@barkleyus.com"},{"name":"sswackhammer","email":"sswackhammer@barkleyus.com"}],"bin":{"dsb":"bin/dsb-build","dsb-ghw":"bin/dsb-github-workflow","dsb-init":"bin/dsb-init","dsb-build":"bin/dsb-build","dsb-serve":"bin/dsb-serve"},"dist":{"shasum":"c4b572708d7848028e124caf8a67828aa9e2f6cc","tarball":"https://registry.npmjs.org/@barkleyrei/doc-site/-/doc-site-0.1.2.tgz","fileCount":16,"integrity":"sha512-z0xUFX9tv85qp+GqfmCb2CM6cPycGV4cHIJTagKZvK4MX6RAdVc2JUV+JuFMEDEaAtW6YHcJQ6j+IiFMrGx4ug==","signatures":[{"sig":"MEUCIFLOBd1hNVOp0/MiYoknPKEzbvp1pC5UaKjtILuYTu9tAiEAu2v8hc2Wy00q2HmXLRTVFVWmLt0He+T1SbhYkTq2B/A=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":18884},"main":"index.js","gitHead":"c035a3561d191e884acedc2c44b6f32ca2a5b415","scripts":{"test":"echo \"Error: no test specified\" && exit 1","doc-site-build":"node index.js"},"_npmUser":{"name":"tyllyn","email":"joshie@gmail.com"},"_npmVersion":"10.9.0","description":"Templated builds for documentation sites.","directories":{},"_nodeVersion":"21.6.1","dependencies":{"shelljs":"^0.8.5","docsify-cli":"^4.4.4"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/doc-site_0.1.2_1734415164014_0.07958368357014889","host":"s3://npm-registry-packages-npm-production"}},"0.1.3":{"name":"@barkleyrei/doc-site","version":"0.1.3","author":"","license":"MIT","_id":"@barkleyrei/doc-site@0.1.3","maintainers":[{"name":"dwhitebr31","email":"dwhite@barkleyus.com"},{"name":"tyllyn","email":"joshie@gmail.com"},{"name":"bzungali","email":"bzungali@barkleyus.com"},{"name":"sswackhammer","email":"sswackhammer@barkleyus.com"}],"bin":{"dsb":"bin/dsb-build","dsb-ghw":"bin/dsb-github-workflow","dsb-init":"bin/dsb-init","dsb-build":"bin/dsb-build","dsb-serve":"bin/dsb-serve"},"dist":{"shasum":"480652c7d8db121da09598605ac68d5f2637831e","tarball":"https://registry.npmjs.org/@barkleyrei/doc-site/-/doc-site-0.1.3.tgz","fileCount":17,"integrity":"sha512-BV8m4oTemr+c1x29HT1ABnA4Z4GfxcfJX/DJRZfDsYZ7Lx4BpkHNdAwBhPZ19if3uO7i6J448W9ZPoxnVmWXmA==","signatures":[{"sig":"MEUCIDSZqgB1KgWqeFcJUitGACKCeGhtilnj1bq5J1FBCJtAAiEA2c3vZOw8zUdNF1+Ob0bkW23bizDpLf9mAwc7DnkNPfg=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":20630},"main":"index.js","gitHead":"3f32d50502aa6d7b26a5c14a674c9fc8fa78fe2b","scripts":{"test":"echo \"Error: no test specified\" && exit 1","doc-site-build":"node index.js"},"_npmUser":{"name":"tyllyn","email":"joshie@gmail.com"},"_npmVersion":"10.9.0","description":"Templated builds for documentation sites.","directories":{},"_nodeVersion":"21.6.1","dependencies":{"shelljs":"^0.8.5","docsify-cli":"^4.4.4"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/doc-site_0.1.3_1736870463156_0.7308203299486815","host":"s3://npm-registry-packages-npm-production"}},"0.1.4":{"name":"@barkleyrei/doc-site","version":"0.1.4","author":"","license":"MIT","_id":"@barkleyrei/doc-site@0.1.4","maintainers":[{"name":"dwhitebr31","email":"dwhite@barkleyus.com"},{"name":"tyllyn","email":"joshie@gmail.com"},{"name":"bzungali","email":"bzungali@barkleyus.com"},{"name":"sswackhammer","email":"sswackhammer@barkleyus.com"}],"bin":{"dsb":"bin/dsb-build","dsb-ghw":"bin/dsb-github-workflow","dsb-init":"bin/dsb-init","dsb-build":"bin/dsb-build","dsb-serve":"bin/dsb-serve"},"dist":{"shasum":"8be1eccfef3f98afac5ed3854e4bbca981ae1e3a","tarball":"https://registry.npmjs.org/@barkleyrei/doc-site/-/doc-site-0.1.4.tgz","fileCount":17,"integrity":"sha512-bNf1HLSH+Z9dcVmkuRmIyuVkHzrnm4fw6AGHsNYUdk7VfjvBmyik/fDYh0bSdEhpJKORYSqIsiptAf3tyg9YWA==","signatures":[{"sig":"MEUCIQDjMVnl1mZS5pKNMPJrNHKtkIPPKnRltc3kkoyndnCZVQIgeYf0Wlfv/g6JwPz4Y8bpv/ejdUX0h7DKcI0YMOXxzXo=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":20345},"main":"index.js","gitHead":"b9b24acc063dc210ecca40698f26037a1366c0e8","scripts":{"test":"echo \"Error: no test specified\" && exit 1","doc-site-build":"node index.js"},"_npmUser":{"name":"tyllyn","email":"joshie@gmail.com"},"_npmVersion":"10.9.0","description":"Templated builds for documentation sites.","directories":{},"_nodeVersion":"21.6.1","dependencies":{"shelljs":"^0.8.5","docsify-cli":"^4.4.4"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/doc-site_0.1.4_1737578089900_0.42813284212501834","host":"s3://npm-registry-packages-npm-production"}},"0.1.5":{"name":"@barkleyrei/doc-site","version":"0.1.5","author":"","license":"MIT","_id":"@barkleyrei/doc-site@0.1.5","maintainers":[{"name":"dwhitebr31","email":"dwhite@barkleyus.com"},{"name":"tyllyn","email":"joshie@gmail.com"},{"name":"bzungali","email":"bzungali@barkleyus.com"},{"name":"sswackhammer","email":"sswackhammer@barkleyus.com"}],"bin":{"dsb":"bin/dsb-build","dsb-ghw":"bin/dsb-github-workflow","dsb-init":"bin/dsb-init","dsb-build":"bin/dsb-build","dsb-serve":"bin/dsb-serve"},"dist":{"shasum":"00531667642aca047fa00c54131f3be3fdf54750","tarball":"https://registry.npmjs.org/@barkleyrei/doc-site/-/doc-site-0.1.5.tgz","fileCount":17,"integrity":"sha512-1xrS+lES7rti84880gQGXEsfXzrvLOD2wihcwvKk7vSYM9cWHyY5PsFX6m6vOURHQbMIIS57cvgS7SF6R+Lfjg==","signatures":[{"sig":"MEQCICs4iMrVdJ5TuSrL6OXBdOIP/7+mRR0kwNGZEpuetAbeAiBzVCOgxrOjvb1UQSFnUOKIqpnuuPpAKjkU9CXo9I+yMA==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":22914},"main":"index.js","gitHead":"13264ce49a58c74eab7684cfddaf61717b9cde0c","scripts":{"test":"echo \"Error: no test specified\" && exit 1","doc-site-build":"node index.js"},"_npmUser":{"name":"tyllyn","email":"joshie@gmail.com"},"_npmVersion":"10.9.0","description":"Templated builds for documentation sites.","directories":{},"_nodeVersion":"21.6.1","dependencies":{"shelljs":"^0.8.5","docsify-cli":"^4.4.4"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/doc-site_0.1.5_1738080385114_0.28209308277932177","host":"s3://npm-registry-packages-npm-production"}},"0.1.6":{"name":"@barkleyrei/doc-site","version":"0.1.6","author":"","license":"MIT","_id":"@barkleyrei/doc-site@0.1.6","maintainers":[{"name":"dwhitebr31","email":"dwhite@barkleyus.com"},{"name":"tyllyn","email":"joshie@gmail.com"},{"name":"bzungali","email":"bzungali@barkleyus.com"},{"name":"sswackhammer","email":"sswackhammer@barkleyus.com"}],"bin":{"dsb":"bin/dsb-build","dsb-ghw":"bin/dsb-github-workflow","dsb-init":"bin/dsb-init","dsb-build":"bin/dsb-build","dsb-serve":"bin/dsb-serve"},"dist":{"shasum":"fedf48c3b43c8e475e793d4e83d8e594225703ed","tarball":"https://registry.npmjs.org/@barkleyrei/doc-site/-/doc-site-0.1.6.tgz","fileCount":17,"integrity":"sha512-1NQdF8Gq95G8SGlPLKliXnRcWchCWQUv/cXwOQMl9l3cGVGzcZlgVy3VkonNxFcTJZNq5KThpupJR+T5jwQzHg==","signatures":[{"sig":"MEYCIQD4d2d298yaeS88c2HmotyB2OnJQWXGd4bCQ9y7ej2CnwIhAMCjEiqjky4Hpi1Z05tEnHiKwOkHbKD++be86bCI5Jk5","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":23289},"main":"index.js","gitHead":"465cb7a7fc310fb7ea7a769f92e482610831f3e0","scripts":{"test":"echo \"Error: no test specified\" && exit 1","doc-site-build":"node index.js"},"_npmUser":{"name":"tyllyn","email":"joshie@gmail.com"},"_npmVersion":"10.9.0","description":"Templated builds for documentation sites.","directories":{},"_nodeVersion":"21.6.1","dependencies":{"shelljs":"^0.8.5","docsify-cli":"^4.4.4"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/doc-site_0.1.6_1738186802657_0.9374791619830725","host":"s3://npm-registry-packages-npm-production"}},"0.1.7":{"name":"@barkleyrei/doc-site","version":"0.1.7","description":"Templated builds for documentation sites.","main":"index.js","bin":{"dsb-init":"bin/dsb-init","dsb":"bin/dsb-build","dsb-build":"bin/dsb-build","dsb-serve":"bin/dsb-serve","dsb-ghw":"bin/dsb-github-workflow"},"scripts":{"doc-site-build":"node index.js","test":"echo \"Error: no test specified\" && exit 1"},"author":"","license":"MIT","dependencies":{"docsify-cli":"^4.4.4","shelljs":"^0.8.5"},"_id":"@barkleyrei/doc-site@0.1.7","gitHead":"ce152fec49e1025c7a1429c4cae91ea2ec36c587","_nodeVersion":"21.6.1","_npmVersion":"10.9.0","dist":{"integrity":"sha512-c22O3+5LU0OIhUK7KMC5d7BQmql9+Fmn16nKMHik6bangqSwCisfsNUjVOyEtXFc4f94KOgSduQWDa/E6pZSPA==","shasum":"9d6c6739679f36aa4af0ffc8339cb3c9972032ab","tarball":"https://registry.npmjs.org/@barkleyrei/doc-site/-/doc-site-0.1.7.tgz","fileCount":17,"unpackedSize":23816,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIER/E7YYLZtw8lPLKUQvH6ejoP8jUu51n32PDO0zAtKTAiBH9ZZB7dM/+GhZ3NY1Ym4wGW/ExMOBi4l+6IhibVTzOA=="}]},"_npmUser":{"name":"tyllyn","email":"joshie@gmail.com"},"directories":{},"maintainers":[{"name":"dwhitebr31","email":"dwhite@barkleyus.com"},{"name":"tyllyn","email":"joshie@gmail.com"},{"name":"bzungali","email":"bzungali@barkleyus.com"},{"name":"sswackhammer","email":"sswackhammer@barkleyus.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/doc-site_0.1.7_1738884016634_0.06017527488307617"},"_hasShrinkwrap":false}},"time":{"created":"2024-12-17T00:24:39.654Z","modified":"2025-02-06T23:20:17.031Z","0.1.0":"2024-12-17T00:24:39.951Z","0.1.1":"2024-12-17T00:37:31.495Z","0.1.2":"2024-12-17T05:59:24.181Z","0.1.3":"2025-01-14T16:01:03.348Z","0.1.4":"2025-01-22T20:34:50.113Z","0.1.5":"2025-01-28T16:06:25.296Z","0.1.6":"2025-01-29T21:40:02.844Z","0.1.7":"2025-02-06T23:20:16.800Z"},"license":"MIT","description":"Templated builds for documentation sites.","maintainers":[{"name":"dwhitebr31","email":"dwhite@barkleyus.com"},{"name":"tyllyn","email":"joshie@gmail.com"},{"name":"bzungali","email":"bzungali@barkleyus.com"},{"name":"sswackhammer","email":"sswackhammer@barkleyus.com"}],"readme":"With just Markdown files (`.md`), you can have a fully functional documentation site using the magic of [Docsify](https://github.com/docsifyjs/docsify). **doc-site** has additional logic built on \ntop of it to ensure consistent formatting between BarkleyOKRP development team documentation. \n\nAdditionally, **doc-site** handles some basic template replacements, and logic to translate code files into standalone displays.\n\n## Quick Start\n\n**doc-site** is hosted on NPM for easy installation and runs - https://www.npmjs.com/package/@barkleyrei/doc-site\n\n- Install **doc-site**: `npm install @barkleyrei/doc-site`\n- Initialize **doc-site** in a folder with your documentation: `dsb-init`\n- Add GitHub workflow files to auto-deploy to GitHub page on publish: `dsb-ghw`\n- Build your **doc-site**: `dsb` or `dsb-build`\n- Run your **doc-site** locally: `dsb-serve`\n\n## Content Building\n\nRoot folder's `README.md` is treated as the \"homepage\" for the **doc-site**, so build out some basic information about your project/doc there. \n\nAlthough not required, a `README.md` file in nested folders are treated as the landing page for that directory.\n\nA variety of files, based on extensions, will be built out to their own stand-alone page, with formatting, within the **doc-site**. The following files are supported for this formatting:\n\n- **XML** (`.xml` extensions)\n- **Velocity** (`.vm` extensions)\n- **PHP** (`.php` extensions)\n- **INI** (`.ini` extensions)\n\n**doc-site** renames some files during build for display within the folder structure. If you want to bypass this, prefix your file with a `~` character. For example, `~.htaccess`.\n\n## Styling\n\nFor styles, refer to the private [BarkleyOKRP Identity Repository](https://github.com/BarkleyREI/identity).\n","readmeFilename":"README.md"}