{"id":24499689,"url":"https://github.com/codewithkyle/dev-docs","last_synced_at":"2025-07-31T02:38:09.814Z","repository":{"id":42524882,"uuid":"261236348","full_name":"codewithkyle/dev-docs","owner":"codewithkyle","description":"Dev Docs is a simple markdown based documentation management tool.","archived":false,"fork":false,"pushed_at":"2023-05-17T11:16:47.000Z","size":548,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-24T02:38:32.001Z","etag":null,"topics":["document-management","documentation-tool","markdown"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/codewithkyle.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-05-04T16:22:12.000Z","updated_at":"2025-05-21T17:41:01.000Z","dependencies_parsed_at":"2023-01-25T21:31:47.124Z","dependency_job_id":null,"html_url":"https://github.com/codewithkyle/dev-docs","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/codewithkyle/dev-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codewithkyle%2Fdev-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codewithkyle%2Fdev-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codewithkyle%2Fdev-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codewithkyle%2Fdev-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codewithkyle","download_url":"https://codeload.github.com/codewithkyle/dev-docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codewithkyle%2Fdev-docs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267978044,"owners_count":24175247,"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","status":"online","status_checked_at":"2025-07-31T02:00:08.723Z","response_time":66,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["document-management","documentation-tool","markdown"],"created_at":"2025-01-21T22:15:17.924Z","updated_at":"2025-07-31T02:38:09.794Z","avatar_url":"https://github.com/codewithkyle.png","language":"JavaScript","readme":"# Dev Docs\n\nDev Docs is a simple markdown based documentation management tool. Simply create markdown files within the generated `docs/` directory and run the `docs` command. No hassle, no fuss, just documentation in a minimalist style.\n\n### Features\n\n-   Dynamically generated navigation structure\n-   Group documents via directories\n-   No configuration required\n-   Light \u0026 dark theme\n\n## Installation\n\nInstall the npm packages\n\n```sh\nnpm i -D @codewithkyle/dev-docs\n```\n\nAdd the startup script to your `package.json` file\n\n```json\n\"docs\": \"docs\"\n```\n\nRun the script\n\n```sh\nnpm run docs\n```\n\n## Flags\n\n```sh\n    -o --output     # Output as static HTML (optional)\n    -c --cname      # CNAME file path (only required for static rendering)\n    -f --favicon    # Favicon file path (optional)\n    -p --port       # Set the documentation server port (optional, defaults to 5000)\n    -s --src        # Location of the markdown files (optional, defaults to ./docs)\n```\n\n## Writing Documentation\n\nCreate new documents by adding markdown files to the `docs/` directory. You can group several documents under a custom header by placing the files together within a subdirectory.\n\n## External Navigation Links\n\nAdd custom external navigation links to the dynamically generated navigation structure (optional).\n\n```json\n\"docs\": {\n    \"name\": \"Overwrite project name\",\n    \"description\": \"Overwrite project description\",\n    \"github\": \"https://github.com/\",\n    \"npm\": \"https://npmjs.com/\"\n}\n```\n\n## GitHub Actions Integration\n\nInstall the [gh-pages](https://www.npmjs.com/package/gh-pages) package and create a `nodejs.yml` file within the `.github/workflows/` directory.\n\n```yml\nname: Build and Deploy\non:\n    push:\n        branches:\n            - master\njobs:\n    build-and-deploy:\n        runs-on: ubuntu-latest\n        steps:\n            - name: Checkout\n              uses: actions/checkout@master\n\n            - name: Setup Node and NPM\n              uses: actions/setup-node@v1\n              with:\n                  node-version: 14.2.0\n\n            - name: Install NPM Packages\n              run: npm ci\n\n            - name: Build\n              run: npm run predeploy\n\n            - name: Deploy\n              run: npm run deploy\n              env:\n                  ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}\n```\n\nCreate the NPM scripts:\n\n```json\n\"predeploy\": \"docs -o ./public -c ./CNAME\",\n\"deploy\": \"node ./deploy.js\"\n```\n\nCreate the `deploy.js` script.\n\n```javascript\nconst ghPages = require(\"gh-pages\");\n\nconst NAME = \"Your Name\";\nconst EMAIL = \"Email\";\nconst USERNAME = \"github-username\";\nconst PROJECT = \"github-project-name\";\n\nghPages.publish(\n    \"public\",\n    {\n        user: {\n            name: NAME,\n            email: EMAIL,\n        },\n        repo: \"https://\" + process.env.ACCESS_TOKEN + \"@github.com/\" + USERNAME + \"/\" + PROJECT + \".git\",\n        silent: true,\n    },\n    (error) =\u003e {\n        if (error) {\n            console.log(error);\n        }\n    }\n);\n```\n\nTo finish adding GitHub Action automated deployment generate a personal access token and add it as a project secret named `ACCESS_TOKEN`\n\n1. Go to your GitHub profile settings\n1. Click on Developer Settings\n1. Click on Person Access Tokens\n1. Generate a new token with `repo` checked\n1. Copy token\n1. Go to project settings\n1. Click on Secrets\n1. Add a new secret named `ACCESS_TOKEN`\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodewithkyle%2Fdev-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodewithkyle%2Fdev-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodewithkyle%2Fdev-docs/lists"}