{"id":28200163,"url":"https://github.com/hernandemonteiro/doc_docs","last_synced_at":"2025-06-12T10:31:59.629Z","repository":{"id":63277413,"uuid":"566131164","full_name":"hernandemonteiro/doc_docs","owner":"hernandemonteiro","description":"package to create documentation for NextJS projects","archived":false,"fork":false,"pushed_at":"2022-11-26T21:01:16.000Z","size":63583,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-05-16T20:11:06.762Z","etag":null,"topics":["docs","jest","nextjs","npm-package","react"],"latest_commit_sha":null,"homepage":"https://doc-docs.vercel.app","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/hernandemonteiro.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-11-15T02:51:33.000Z","updated_at":"2023-06-13T21:07:26.000Z","dependencies_parsed_at":"2023-01-22T06:54:36.458Z","dependency_job_id":null,"html_url":"https://github.com/hernandemonteiro/doc_docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/hernandemonteiro/doc_docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hernandemonteiro%2Fdoc_docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hernandemonteiro%2Fdoc_docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hernandemonteiro%2Fdoc_docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hernandemonteiro%2Fdoc_docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hernandemonteiro","download_url":"https://codeload.github.com/hernandemonteiro/doc_docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hernandemonteiro%2Fdoc_docs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259447450,"owners_count":22859055,"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":["docs","jest","nextjs","npm-package","react"],"created_at":"2025-05-16T20:10:50.111Z","updated_at":"2025-06-12T10:31:59.615Z","avatar_url":"https://github.com/hernandemonteiro.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eDOC DOCS - NEXTJS DOCUMENTATION\u003c/h1\u003e\n\u003cdiv align=\"center\"\u003e\n\u003cimg style=\"width:70%\" src=\"./website/public/Thesis-rafiki.png\"/\u003e\n\u003c/div\u003e\n\u003chr\u003e\n\u003cp align=\"center\"\u003e\ndoc_docs is for NextJS projects, he use the file routing method of NextJS to create a custom documentation.\n\u003c/p\u003e\n\u003chr\u003e\n\n\u003c!-- \u003ca style=\"font-size: 1.4rem\" href=\"https://doc-docs.vercel.app/docs\" target=\"_blank\"\u003eClick here to acess the complete documentation\u003c/a\u003e --\u003e\n\n### TO USE\n\ninstall the package:\n\n```\nnpm i doc_docs\n```\n\nafter:\n\n```\nimport ComponentOrDocs from \"doc_docs\";\n```\n\nafter init the basic configuration:\n\n- remove the `\u003cComponent {...pageProps} /\u003e` of `_app`;\n- add the `\u003cComponentOrDocs/\u003e`;\n- add `router` to args function;\n- pass basic properties to component:\n\n```\n\u003cComponentOrDocs\n    Component={Component}\n    pageProps={pageProps}\n    route={router}/\u003e\n```\n\n##### Example:\n\n```\nimport React from \"react\";\nimport ComponentOrDocs from \"doc_docs\";\nimport \"./_app.css\";\n\nfunction MyApp({ Component, pageProps, router }) {\n  return (\n    \u003cComponentOrDocs\n      Component={Component}\n      pageProps={pageProps}\n      route={router}\n      configDirs={{\n        dirs: [ \"api\", \"other_path\"],\n        subDirs: { api: [\"user\", \"auth\"] },\n      }}\n    /\u003e\n  );\n}\n\nexport default MyApp;\n```\n\nNow you can create a folder `docs` inside your folder `pages`;\n- inside the folder docs create a index file.\nJust it... your doc_docs is done!\n\n### MENU\n\nto config your menu you can create folders inside the `docs` folder;\nand to display you just need change the atribute `configDirs` in your\n`_app` component;\n\n`dirs:` is a simple folder with the index file inside;\n`subDirs:` is a submenu configuration to create a select folder in menu;\n\n##### Example:\n\n```\nimport React from \"react\";\nimport ComponentOrDocs from \"doc_docs\";\nimport \"./_app.css\";\n\nfunction MyApp({ Component, pageProps, router }) {\n  return (\n    \u003cComponentOrDocs\n      Component={Component}\n      pageProps={pageProps}\n      route={router}\n      // this is a menu configuration;\n      configDirs={{\n        dirs: [ \"api\", \"other_path\"],\n        subDirs: { api: [\"user\", \"auth\"] },\n      }}\n      // end of menu configuration;\n    /\u003e\n  );\n}\n\nexport default MyApp;\n```\n\n### CUSTOM LOGO\n\nto set a custom logo you can use `projectLogo` attribute;\n\nthis attribute accept a JSX.Element or a String;\n\n##### Example:\n\n```\nimport React from \"react\";\nimport ComponentOrDocs from \"doc_docs\";\nimport \"./_app.css\";\n\nfunction MyApp({ Component, pageProps, router }) {\n  return (\n    \u003cComponentOrDocs\n      Component={Component}\n      pageProps={pageProps}\n      route={router}\n      configDirs={{\n        dirs: [ \"api\", \"other_path\"],\n        subDirs: { api: [\"user\", \"auth\"] },\n      }}\n\n      projectLogo={your custom logo here}\n    /\u003e\n  );\n}\n\nexport default MyApp;\n```\n\n### SOCIAL NETWORK\n\nto add header icons with your social networks you can\nuse the principal component;\n\nYou can set:\n\n- github;\n- website;\n- instagram;\n- linkedin;\n- discord;\n- facebook;\n\n##### Example:\n\n```\nimport React from \"react\";\nimport ComponentOrDocs from \"doc_docs\";\nimport \"./_app.css\";\n\nfunction MyApp({ Component, pageProps, router }) {\n  return (\n    \u003cComponentOrDocs\n      Component={Component}\n      pageProps={pageProps}\n      route={router}\n      configDirs={{\n        dirs: [ \"api\", \"other_path\"],\n        subDirs: { api: [\"user\", \"auth\"] },\n      }}\n\n      // example social networks:\n\n      github=\"https://github.com/your_nickname\"\n      website=\"https://your_website.com\"\n      instagram=\"https://instagram.com/your_username\"\n    /\u003e\n  );\n}\n\nexport default MyApp;\n```\n\n### PREBUILT COMPONENTS\n\n`import { name_of_component } from \"doc_docs/components\"`\n\n##### Components:\n\n`TitleDoc:`\n\nTitle for page docs!\n\n```\n\u003cTitleDoc title=\"Your Title\" /\u003e\n```\n\n`ComponentDoc:`\n\n- `options` and `description` is optional;\n- `options` config a table with the component props;\n\n```\n \u003cComponentDoc\n        background=\"grey\"\n        element={\u003ch1\u003eHere you can expose Components\u003c/h1\u003e}\n        options={[\n          { prop: \"OnClick\", default: \"none\", accept: \"() =\u003e void\" },\n          { prop: \"children\", default: \"none\", accept: \"string\" },\n        ]}\n        description={\n          \"optional description for this\"\n        }\n      /\u003e\n\n```\n\n`Code:`\n\n```\n\u003cCode\n  language=\"name_of_language\"\n  code={Your code here} /\u003e\n```\n\n`DescriptionDoc:`\n\n```\n\u003cDescriptionDoc\n    description=\"this is a description example\" /\u003e\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhernandemonteiro%2Fdoc_docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhernandemonteiro%2Fdoc_docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhernandemonteiro%2Fdoc_docs/lists"}