{"id":15817025,"url":"https://github.com/numminorihsf/documentation-config-prepare","last_synced_at":"2025-07-12T01:07:49.342Z","repository":{"id":56549327,"uuid":"144922115","full_name":"NumminorihSF/documentation-config-prepare","owner":"NumminorihSF","description":"Package to generate big config for documentation.js","archived":false,"fork":false,"pushed_at":"2025-06-18T10:55:29.000Z","size":18,"stargazers_count":0,"open_issues_count":7,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-18T11:48:04.506Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/NumminorihSF.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-08-16T01:43:05.000Z","updated_at":"2018-08-16T01:49:09.000Z","dependencies_parsed_at":"2024-10-26T11:20:32.175Z","dependency_job_id":null,"html_url":"https://github.com/NumminorihSF/documentation-config-prepare","commit_stats":{"total_commits":2,"total_committers":1,"mean_commits":2.0,"dds":0.0,"last_synced_commit":"c2e55d874aab5c79d04033a2d3dae53bf6120375"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/NumminorihSF/documentation-config-prepare","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NumminorihSF%2Fdocumentation-config-prepare","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NumminorihSF%2Fdocumentation-config-prepare/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NumminorihSF%2Fdocumentation-config-prepare/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NumminorihSF%2Fdocumentation-config-prepare/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NumminorihSF","download_url":"https://codeload.github.com/NumminorihSF/documentation-config-prepare/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NumminorihSF%2Fdocumentation-config-prepare/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264922866,"owners_count":23683701,"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":[],"created_at":"2024-10-05T05:21:41.249Z","updated_at":"2025-07-12T01:07:49.309Z","avatar_url":"https://github.com/NumminorihSF.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# documentation-config-prepare\n\nThis is a small tool for prepare the documentation.js config from its part\nthat present in file tree. Wrote for `@saritasa/generator-react` and \n`react-app-core` so there is no customisation for current moment, but tool is pretty small,\nso you may do PR or write your own.\n\n## How to use\nFor single-time usage, you may run\n```bash\nnpx documentation-config-prepare\n```\n\nFor regular usage it's recommended to use\n1. `npm install --save-dev documentation-config-prepare`\n2. Create `predoc` script inside package.json like `\"predoc\": \"documentation-config-prepare\"`\n3. If you run `npm run doc` for building the documentation, `predoc` runs before it\n\n## What does it do\nThis tool use yaml files that named like `documentation.yml` or `MyModule.documentation.yml`,\nwhere `MyModule` is custom part.\n\nThe algorithm is next:\n1. Take all files by glob from `src` folder and remember theirs paths.\n2. Parse paths to understand if documentation file were created for `feature` or not (looking for `/features/` in path).\n3. Sort all files like:\n```\nfile1\nfile2 \u003c-- all files except features are sorted in alphabetical order \nfile3\nfeature1 \u003c-- after regular files, features goes (alphabetical order too)\nfeature2\nfeature2-file1 \u003c-- every feature's regular file is placed rigth after main feature description \nfeature2-file2 \u003c-- (alphabetical order too)\nfeature2.1 (nested for feature2) \u003c-- every nested feature goes after regular feature's files\nfeature2.2 (nested for feature2)\nfeature3\nfeature4\n```\n4. Take file's content from `toc` key and concat it with another.\n5. Write `documentation.yml` into `process.cwd()`.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnumminorihsf%2Fdocumentation-config-prepare","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnumminorihsf%2Fdocumentation-config-prepare","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnumminorihsf%2Fdocumentation-config-prepare/lists"}