{"_id":"@aiandralves/ai-docs","_rev":"7-851e88aac5c071d00c7081e89a376bfc","name":"@aiandralves/ai-docs","dist-tags":{"latest":"0.1.4"},"versions":{"0.0.8":{"name":"@aiandralves/ai-docs","version":"0.0.8","keywords":["ai-ui","angular","typescript","tailwindcss"],"author":{"name":"Aiandra Alves","email":"aiandraalves.meira@gmail.com"},"license":"MIT","_id":"@aiandralves/ai-docs@0.0.8","maintainers":[{"name":"aiandralves","email":"aiandraalves.meira@gmail.com"}],"homepage":"https://ai-ui.aiandralves.com.br/","bugs":{"url":"https://github.com/aiandrameira/ai-docs/issues"},"bin":{"ai-docs":"index.cjs"},"dist":{"shasum":"0f99fec2714556648d8c316768d5b2962384513c","tarball":"https://registry.npmjs.org/@aiandralves/ai-docs/-/ai-docs-0.0.8.tgz","fileCount":739,"integrity":"sha512-x6NRJhvm5Clq84cR/blOks8WJ4A/Ry8WgQgXGlVM2ZQNdzvA58nv487lPxxDPxCbmmh0Xlx7UpU3Bp+PmPXOtg==","signatures":[{"sig":"MEQCIH9hzEOlpWa5TP/CS03H4o2fg2EfjWByUfKFiobzRIUgAiBOGBSzWOhS28I6HYtCKc8OlmDAksl6568PeGwmH9F8aA==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":44231804},"main":"./index.cjs","type":"commonjs","types":"./src/index.d.ts","exports":{".":{"types":"./src/index.d.ts","default":"./index.cjs"},"./config":{"types":"./src/config.d.ts","default":"./config.cjs"}},"gitHead":"c254e85c3a0b00090b87e2e0fb8402c5992e0844","_npmUser":{"name":"aiandralves","email":"aiandraalves.meira@gmail.com"},"repository":{"url":"git+https://github.com/aiandrameira/ai-docs.git","type":"git"},"_npmVersion":"11.6.2","description":"A comprehensive Angular UI component library with Tailwind CSS","directories":{},"_nodeVersion":"24.13.0","dependencies":{"mermaid":"^11.16.0"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/ai-docs_0.0.8_1785199274312_0.3668481842286646","host":"s3://npm-registry-packages-npm-production"}},"0.0.9":{"name":"@aiandralves/ai-docs","version":"0.0.9","keywords":["ai-ui","angular","typescript","tailwindcss"],"author":{"name":"Aiandra Alves","email":"aiandraalves.meira@gmail.com"},"license":"MIT","_id":"@aiandralves/ai-docs@0.0.9","maintainers":[{"name":"aiandralves","email":"aiandraalves.meira@gmail.com"}],"homepage":"https://ai-docs.aiandralves.com.br","bugs":{"url":"https://github.com/aiandrameira/ai-docs/issues"},"bin":{"ai-docs":"index.cjs"},"dist":{"shasum":"450fa3edd5f05c9e9a1a5a805831bbf6ca4ccb5f","tarball":"https://registry.npmjs.org/@aiandralves/ai-docs/-/ai-docs-0.0.9.tgz","fileCount":739,"integrity":"sha512-mHeWIuhmM2tV4CLySjzZGrDytO9i6c+XW8Osk+04A6c3kvSJSIhb+jMM+NS93zmd3KKgST2LLLqfM6GUV+bt0w==","signatures":[{"sig":"MEQCIEBrcaJRSqsjqQ3u9A47sujm/7/ZFbd/9wr8N0C38dfgAiBoiwMKUFl+Lv99hUWli6V8UdpQWi3XQj1m2XIY5Gco5w==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":44255842},"main":"./index.cjs","type":"commonjs","types":"./src/index.d.ts","exports":{".":{"types":"./src/index.d.ts","default":"./index.cjs"},"./config":{"types":"./src/config.d.ts","default":"./config.cjs"}},"gitHead":"7dae813a99d3c8e1e45cb09fa5775d9eac6c265a","_npmUser":{"name":"aiandralves","email":"aiandraalves.meira@gmail.com"},"repository":{"url":"git+https://github.com/aiandrameira/ai-docs.git","type":"git"},"_npmVersion":"11.6.2","description":"Gerador de documentação estática para projetos TypeScript com Angular SSR.","directories":{},"_nodeVersion":"24.13.0","dependencies":{"mermaid":"^11.16.0"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/ai-docs_0.0.9_1785203308379_0.388636556867064","host":"s3://npm-registry-packages-npm-production"}},"0.1.0":{"name":"@aiandralves/ai-docs","version":"0.1.0","keywords":["ai-ui","angular","typescript","tailwindcss"],"author":{"name":"Aiandra Alves","email":"aiandraalves.meira@gmail.com"},"license":"MIT","_id":"@aiandralves/ai-docs@0.1.0","maintainers":[{"name":"aiandralves","email":"aiandraalves.meira@gmail.com"}],"homepage":"https://ai-docs.aiandralves.com.br","bugs":{"url":"https://github.com/aiandrameira/ai-docs/issues"},"bin":{"ai-docs":"index.cjs"},"dist":{"shasum":"f0b3cf988a290254fedbaef83832a09a18652671","tarball":"https://registry.npmjs.org/@aiandralves/ai-docs/-/ai-docs-0.1.0.tgz","fileCount":740,"integrity":"sha512-wY05QnxaIAchBNNgqH5DvqA8DvbANrw3rpHXWZplLUqlWTzKQhS/UyNoPP69Fg919EKHp7R2VG+vQd+6xwmkRw==","signatures":[{"sig":"MEYCIQDCxiPmFN1RKrCyTj4cAomPtqZrBVsLFRpCgbUQ4HKgDQIhALUhr7RxFvHqiRZrGP9qsYC8QUVqRi/dBK4GtQsSExaA","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":44264301},"main":"./index.cjs","type":"commonjs","types":"./src/index.d.ts","exports":{".":{"types":"./src/index.d.ts","default":"./index.cjs"},"./config":{"types":"./src/config.d.ts","default":"./config.cjs"}},"gitHead":"009e3d105819978902a3afd48077e6ecb0b864a5","_npmUser":{"name":"aiandralves","email":"aiandraalves.meira@gmail.com"},"repository":{"url":"git+https://github.com/aiandrameira/ai-docs.git","type":"git"},"_npmVersion":"11.6.2","description":"Gerador de documentação estática para projetos TypeScript com Angular SSR.","directories":{},"_nodeVersion":"24.13.0","dependencies":{"mermaid":"^11.16.0"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/ai-docs_0.1.0_1785593608805_0.41386502631120137","host":"s3://npm-registry-packages-npm-production"}},"0.1.1":{"name":"@aiandralves/ai-docs","version":"0.1.1","keywords":["ai-ui","angular","typescript","tailwindcss"],"author":{"name":"Aiandra Alves","email":"aiandraalves.meira@gmail.com"},"license":"MIT","_id":"@aiandralves/ai-docs@0.1.1","maintainers":[{"name":"aiandralves","email":"aiandraalves.meira@gmail.com"}],"homepage":"https://ai-docs.aiandralves.com.br","bugs":{"url":"https://github.com/aiandrameira/ai-docs/issues"},"bin":{"ai-docs":"index.cjs"},"dist":{"shasum":"a00a1cb855a1a5d7dca9ced9a3e7fcb3cd467ea6","tarball":"https://registry.npmjs.org/@aiandralves/ai-docs/-/ai-docs-0.1.1.tgz","fileCount":740,"integrity":"sha512-bNlK+DLC9Zah9RLFjf3Iy5RQ8lwGutvgs1kwDmpU2OVFdJ4hwaRHuBklzFBe1BtoJE2w1U+WB38qV/S2BdgxDA==","signatures":[{"sig":"MEUCIHoTCueATouteL7lVqTSzxdDIKUAi2gnT+kjdVe/rDfqAiEA4PMAa9oih4Uz7yhN8PlfHdicgzRDT764vDrBXKimV30=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":44258975},"main":"./index.cjs","type":"commonjs","types":"./src/index.d.ts","exports":{".":{"types":"./src/index.d.ts","default":"./index.cjs"},"./config":{"types":"./src/config.d.ts","default":"./config.cjs"}},"gitHead":"175e54e4e529ab8d4cd9473b14d9386cdb6d2628","_npmUser":{"name":"aiandralves","email":"aiandraalves.meira@gmail.com"},"repository":{"url":"git+https://github.com/aiandrameira/ai-docs.git","type":"git"},"_npmVersion":"11.6.2","description":"Gerador de documentação estática para projetos TypeScript com Angular SSR.","directories":{},"_nodeVersion":"24.13.0","dependencies":{"mermaid":"^11.16.0"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/ai-docs_0.1.1_1785598545292_0.2800069728048704","host":"s3://npm-registry-packages-npm-production"}},"0.1.2":{"name":"@aiandralves/ai-docs","version":"0.1.2","keywords":["ai-ui","angular","typescript","tailwindcss"],"author":{"name":"Aiandra Alves","email":"aiandraalves.meira@gmail.com"},"license":"MIT","_id":"@aiandralves/ai-docs@0.1.2","maintainers":[{"name":"aiandralves","email":"aiandraalves.meira@gmail.com"}],"homepage":"https://ai-docs.aiandralves.com.br","bugs":{"url":"https://github.com/aiandrameira/ai-docs/issues"},"bin":{"ai-docs":"index.cjs"},"dist":{"shasum":"98e8fc925dda417e3a5bb7f41511dc9897417cb8","tarball":"https://registry.npmjs.org/@aiandralves/ai-docs/-/ai-docs-0.1.2.tgz","fileCount":740,"integrity":"sha512-XvNQD0iVXmQor3cUpgrzu43imip39dVQHucYbvv7j919NhST6d+ShS7C4S3/hz6UviORPj0TZb6YzKECcACuvg==","signatures":[{"sig":"MEUCIQCt6kdhs6DjGSkZmXKon4j71284YjBL8sHlJxjrdcVXWAIgJinM4EklPo8xlmKDh60rCQNL3THw6yJWSyk4vMPOTTQ=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":44295445},"main":"./index.cjs","type":"commonjs","types":"./src/index.d.ts","exports":{".":{"types":"./src/index.d.ts","default":"./index.cjs"},"./config":{"types":"./src/config.d.ts","default":"./config.cjs"}},"gitHead":"96f3cb2865e76763d73d20b9b06b5bcc9d6c86f4","_npmUser":{"name":"aiandralves","email":"aiandraalves.meira@gmail.com"},"repository":{"url":"git+https://github.com/aiandrameira/ai-docs.git","type":"git"},"_npmVersion":"11.6.2","description":"Gerador de documentação estática para projetos TypeScript com Angular SSR.","directories":{},"_nodeVersion":"24.13.0","dependencies":{"mermaid":"^11.16.0"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/ai-docs_0.1.2_1786228372138_0.5685557881266845","host":"s3://npm-registry-packages-npm-production"}},"0.1.3":{"name":"@aiandralves/ai-docs","version":"0.1.3","keywords":["ai-ui","angular","typescript","tailwindcss"],"author":{"name":"Aiandra Alves","email":"aiandraalves.meira@gmail.com"},"license":"MIT","_id":"@aiandralves/ai-docs@0.1.3","maintainers":[{"name":"aiandralves","email":"aiandraalves.meira@gmail.com"}],"homepage":"https://ai-docs.aiandralves.com.br","bugs":{"url":"https://github.com/aiandrameira/ai-docs/issues"},"bin":{"ai-docs":"index.cjs"},"dist":{"shasum":"647e4ef4747d3e5c534d4e7829c106c265d69ef5","tarball":"https://registry.npmjs.org/@aiandralves/ai-docs/-/ai-docs-0.1.3.tgz","fileCount":740,"integrity":"sha512-WRH7ZX8+teEzvvlYUy2y6NxBJJbBRn42ecHaaZHzIoHxkHN1euSCEXhXcdCpXN5+ac5RwfLAqPdsUWIeVSqM0A==","signatures":[{"sig":"MEUCIQDjl163xcEJleh12zY/rFxdFZbkwWU6sbccuhzWK3+RPAIgPhwGO5M8DviMoP+xvD8rpSI5gluGJROI3wg/NQlODJM=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":44295445},"main":"./index.cjs","type":"commonjs","types":"./src/index.d.ts","exports":{".":{"types":"./src/index.d.ts","default":"./index.cjs"},"./config":{"types":"./src/config.d.ts","default":"./config.cjs"}},"gitHead":"de1b44098e56ddc7453e526c6484655a0146a027","_npmUser":{"name":"aiandralves","email":"aiandraalves.meira@gmail.com"},"repository":{"url":"git+https://github.com/aiandrameira/ai-docs.git","type":"git"},"_npmVersion":"11.6.2","description":"Gerador de documentação estática para projetos TypeScript com Angular SSR.","directories":{},"_nodeVersion":"24.13.0","dependencies":{"mermaid":"^11.16.0"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/ai-docs_0.1.3_1786229539666_0.8193649272714849","host":"s3://npm-registry-packages-npm-production"}},"0.1.4":{"name":"@aiandralves/ai-docs","version":"0.1.4","description":"Gerador de documentação estática para projetos TypeScript com Angular SSR.","repository":{"type":"git","url":"git+https://github.com/aiandrameira/ai-docs.git"},"author":{"name":"Aiandra Alves","email":"aiandraalves.meira@gmail.com"},"license":"MIT","keywords":["ai-ui","angular","typescript","tailwindcss"],"homepage":"https://ai-docs.aiandralves.com.br","type":"commonjs","main":"./index.cjs","types":"./src/index.d.ts","bin":{"ai-docs":"index.cjs"},"dependencies":{"mermaid":"^11.16.0"},"exports":{".":{"types":"./src/index.d.ts","default":"./index.cjs"},"./config":{"types":"./src/config.d.ts","default":"./config.cjs"}},"publishConfig":{"registry":"https://registry.npmjs.org/","access":"public"},"gitHead":"de1b44098e56ddc7453e526c6484655a0146a027","_id":"@aiandralves/ai-docs@0.1.4","bugs":{"url":"https://github.com/aiandrameira/ai-docs/issues"},"_nodeVersion":"24.13.0","_npmVersion":"11.6.2","dist":{"integrity":"sha512-SKQvgLySby7ktUsyCdgOE7g6TkJcSZ9rfj5llTSccdfA+/5buKZIl8cwH9wP9O0thw8oPn2UB/dPcE/q1y7JnA==","shasum":"dabfd0bef00c4e70241d69e200cbe78705b396c1","tarball":"https://registry.npmjs.org/@aiandralves/ai-docs/-/ai-docs-0.1.4.tgz","fileCount":740,"unpackedSize":44295670,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQDPO/X0/n06njLGbDDbXSERjDA1RR7sdFonmNyQvonBcwIgSuOyVxnzVtEQEQHQ22QHxg1IHccfuTFAroZSQIM8/6Y="}]},"_npmUser":{"name":"aiandralves","email":"aiandraalves.meira@gmail.com"},"directories":{},"maintainers":[{"name":"aiandralves","email":"aiandraalves.meira@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/ai-docs_0.1.4_1786230335751_0.8638469173832735"},"_hasShrinkwrap":false}},"time":{"created":"2026-07-28T00:41:14.094Z","modified":"2026-08-08T23:05:36.218Z","0.0.8":"2026-07-28T00:41:14.617Z","0.0.9":"2026-07-28T01:48:28.643Z","0.1.0":"2026-08-01T14:13:29.138Z","0.1.1":"2026-08-01T15:35:45.585Z","0.1.2":"2026-08-08T22:32:52.399Z","0.1.3":"2026-08-08T22:52:19.951Z","0.1.4":"2026-08-08T23:05:36.034Z"},"bugs":{"url":"https://github.com/aiandrameira/ai-docs/issues"},"author":{"name":"Aiandra Alves","email":"aiandraalves.meira@gmail.com"},"license":"MIT","homepage":"https://ai-docs.aiandralves.com.br","keywords":["ai-ui","angular","typescript","tailwindcss"],"repository":{"type":"git","url":"git+https://github.com/aiandrameira/ai-docs.git"},"description":"Gerador de documentação estática para projetos TypeScript com Angular SSR.","maintainers":[{"name":"aiandralves","email":"aiandraalves.meira@gmail.com"}],"readme":"# @aiandralves/ai-docs\n\n<p align=\"center\">\n  <img src=\"https://raw.githubusercontent.com/aiandrameira/ai-docs/c254e85c3a0b00090b87e2e0fb8402c5992e0844/apps/web/public/img/logo.svg\" width=\"80\" alt=\"Logo do Ai\" />\n</p>\n\n<p align=\"center\">\n    <strong>Gere um site de documentação estático a partir de Markdown.</strong><br />\n    Pronto para projetos TypeScript, com busca, dark mode, syntax highlight e Mermaid.\n</p>\n\n<p align=\"center\">\n    <a href=\"https://www.npmjs.com/package/@aiandralves/ai-docs\"><img src=\"https://img.shields.io/npm/v/@aiandralves/ai-docs\" alt=\"Versão no npm\" /></a>\n    <a href=\"https://www.npmjs.com/package/@aiandralves/ai-docs\"><img src=\"https://img.shields.io/npm/dm/@aiandralves/ai-docs\" alt=\"Downloads no npm\" /></a>\n    <img src=\"https://img.shields.io/badge/Node.js-%3E%3D20-339933\" alt=\"Node.js 20 ou superior\" />\n</p>\n\n<p align=\"center\">\n    <img src=\"https://raw.githubusercontent.com/aiandrameira/ai-docs/main/preview.png\" width=\"800\" alt=\"Prévia de um site criado com AiDocs\" />\n</p>\n\n## Instalação\n\nRequer Node.js 20 ou superior.\n\n```bash\nnpm install --save-dev @aiandralves/ai-docs\n```\n\nO pacote está disponível no npm público. Não é necessário configurar um registry privado nem usar um token do GitHub.\n\n## Início rápido\n\nInicialize a documentação no diretório atual:\n\n```bash\nnpx ai-docs init\n```\n\nEsse comando cria:\n\n```text\nseu-projeto/\n├── ai-docs.config.ts\n└── docs/\n    └── index.md\n```\n\nAdicione os scripts:\n\n```json\n{\n    \"scripts\": {\n        \"docs:dev\": \"ai-docs dev\",\n        \"docs:build\": \"ai-docs build\"\n    }\n}\n```\n\nInicie o servidor local:\n\n```bash\nnpm run docs:dev\n```\n\nAcesse `http://localhost:4000`. Para escolher outra porta, use `ai-docs dev --port 3000`.\n\nGere o site para produção:\n\n```bash\nnpm run docs:build\n```\n\nO resultado é um conjunto de arquivos estáticos no diretório configurado em `output`, pronto para deploy.\n\n## Configuração\n\nEdite `ai-docs.config.ts`:\n\n```ts\nimport { defineConfig } from \"@aiandralves/ai-docs/config\";\n\nexport default defineConfig({\n    title: \"Minha biblioteca\",\n    description: \"Documentação oficial da minha biblioteca.\",\n    docs: \"./docs\",\n    output: \"./dist/docs\",\n    base: \"/\",\n    logo: \"/assets/logo.svg\",\n    github: \"https://github.com/usuario/projeto\",\n    features: {\n        search: true,\n        darkMode: true,\n        copyCode: true,\n        mermaid: true,\n    },\n});\n```\n\nOpções mais usadas:\n\n| Opção              | Descrição                                                |\n| ------------------ | -------------------------------------------------------- |\n| `title`            | Nome exibido no site                                     |\n| `description`      | Descrição padrão para metadados                          |\n| `docs`             | Diretório dos arquivos Markdown                          |\n| `output`           | Diretório dos arquivos gerados                           |\n| `base`             | Caminho base do deploy, como `/meu-repo/`                |\n| `logo` e `favicon` | Identidade visual do site                                |\n| `github`           | Link do repositório exibido no cabeçalho                 |\n| `nav`              | Links adicionais de navegação                            |\n| `theme.customCss`  | Arquivo CSS adicional                                    |\n| `features`         | Busca, tema, cópia de código, Mermaid e edição no GitHub |\n\n## Criando páginas\n\nTodo arquivo `.md` dentro do diretório `docs` vira uma página. Pastas criam grupos de navegação.\n\n```md\n---\ntitle: Instalação\ndescription: Como instalar o projeto.\norder: 2\n---\n\n# Instalação\n\nConteúdo da página.\n```\n\nO frontmatter também aceita `draft`, `sidebar`, `toc` e `breadcrumb`.\n\nPara criar um diagrama, habilite `features.mermaid` e use:\n\n````md\n```mermaid\ngraph LR\n  A[Markdown] --> B[AiDocs]\n  B --> C[Site estático]\n```\n````\n\n## CLI\n\n| Comando                             | Descrição                                          |\n| ----------------------------------- | -------------------------------------------------- |\n| `ai-docs init [diretório]`          | Cria a configuração e os arquivos iniciais         |\n| `ai-docs dev`                       | Inicia o servidor local com atualização automática |\n| `ai-docs build`                     | Gera o site estático                               |\n| `ai-docs dev --port 3000`           | Inicia o servidor em outra porta                   |\n| `ai-docs build --config caminho.ts` | Usa outro arquivo de configuração                  |\n\n## Deploy\n\nPublique o diretório definido em `output` em qualquer hospedagem estática. Em deploys sob um subdiretório, como GitHub Pages, ajuste `base`:\n\n```ts\nexport default defineConfig({\n    // ...\n    output: \"./dist/docs\",\n    base: \"/nome-do-repositorio/\",\n});\n```\n\n## Links\n\n- [Código-fonte e issues](https://github.com/aiandrameira/ai-docs)\n- [Pacote no npm](https://www.npmjs.com/package/@aiandralves/ai-docs)\n- [Documentação no repositório](https://github.com/aiandrameira/ai-docs/tree/main/docs)\n\n## Licença\n\nMIT © Aiandra Alves\n","readmeFilename":"README.md"}