{"id":49535629,"url":"https://github.com/freepicheep/nu-doc-gen","last_synced_at":"2026-05-02T10:04:28.945Z","repository":{"id":351876944,"uuid":"1212876723","full_name":"freepicheep/nu-doc-gen","owner":"freepicheep","description":"Creates a nice static documentation site for your Nu module","archived":false,"fork":false,"pushed_at":"2026-04-27T14:45:44.000Z","size":128,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-27T16:26:30.650Z","etag":null,"topics":["documentation-generator","nu","nushell","nushell-module","static-site-generator"],"latest_commit_sha":null,"homepage":"https://freepicheep.github.io/nu-doc-gen/","language":"Nushell","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/freepicheep.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-04-16T20:25:09.000Z","updated_at":"2026-04-24T16:57:23.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/freepicheep/nu-doc-gen","commit_stats":null,"previous_names":["freepicheep/nu-doc-gen"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/freepicheep/nu-doc-gen","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/freepicheep%2Fnu-doc-gen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/freepicheep%2Fnu-doc-gen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/freepicheep%2Fnu-doc-gen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/freepicheep%2Fnu-doc-gen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/freepicheep","download_url":"https://codeload.github.com/freepicheep/nu-doc-gen/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/freepicheep%2Fnu-doc-gen/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32530178,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-02T01:12:54.858Z","status":"online","status_checked_at":"2026-05-02T02:00:05.923Z","response_time":132,"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":["documentation-generator","nu","nushell","nushell-module","static-site-generator"],"created_at":"2026-05-02T10:04:28.284Z","updated_at":"2026-05-02T10:04:28.934Z","avatar_url":"https://github.com/freepicheep.png","language":"Nushell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# nu-doc-gen\n\nThis is a simple Nu module to generate static site and markdown documentation for Nu modules.\n\n## Building a Static Site\n\nBuild a static HTML/CSS/JS documentation site from a module repo. Each `.nu` file becomes a category when the module has more than just `mod.nu`. Light and dark site palettes come from the bundled `nu-doc-gen/themes.toml` registry, which maps supported Shiki themes to bundled Ghostty color schemes.\n\n```nushell\ngenerate-doc-site \u003cmodule_path?\u003e \u003coutput_dir?\u003e --light-theme \u003cshiki_theme?\u003e --dark-theme \u003cshiki_theme?\u003e\n```\n\n\u003cdetails\u003e\n\u003csummary\u003eSupported Themes\u003c/summary\u003e\n\n\n| Theme | Shiki Name (use in command) | Mode |\n| --- | --- | --- |\n| Ayu Mirage | ayu-mirage | dark |\n| Ayu | ayu-dark | dark |\n| Andromeda | andromeeda | dark |\n| Catppuccin Frappe | catppuccin-frappe | dark |\n| Catppuccin Macchiato | catppuccin-macchiato | dark |\n| Catppuccin Mocha | catppuccin-mocha | dark |\n| Dark+ | dark-plus | dark |\n| Dracula | dracula | dark |\n| Everforest Dark Hard | everforest-dark | dark |\n| GitHub Dark | github-dark | dark |\n| GitHub Dark Default | github-dark-default | dark |\n| GitHub Dark Dimmed | github-dark-dimmed | dark |\n| GitHub Dark High Contrast | github-dark-high-contrast | dark |\n| Gruvbox Dark Hard | gruvbox-dark-hard | dark |\n| Gruvbox Dark | gruvbox-dark-medium | dark |\n| Gruvbox Dark | gruvbox-dark-soft | dark |\n| Horizon | horizon | dark |\n| Kanagawa Dragon | kanagawa-dragon | dark |\n| Kanagawa Wave | kanagawa-wave | dark |\n| Material | material-theme | dark |\n| Material Darker | material-theme-darker | dark |\n| Material Ocean | material-theme-ocean | dark |\n| Night Owl | night-owl | dark |\n| Nord | nord | dark |\n| Poimandres | poimandres | dark |\n| Rose Pine | rose-pine | dark |\n| Rose Pine Moon | rose-pine-moon | dark |\n| Synthwave | synthwave-84 | dark |\n| TokyoNight | tokyo-night | dark |\n| Vesper | vesper | dark |\n| Ayu Light | ayu-light | light |\n| Catppuccin Latte | catppuccin-latte | light |\n| Everforest Light Med | everforest-light | light |\n| GitHub | github-light | light |\n| GitHub Light Default | github-light-default | light |\n| GitHub Light High Contrast | github-light-high-contrast | light |\n| Gruvbox Light Hard | gruvbox-light-hard | light |\n| Gruvbox Light | gruvbox-light-medium | light |\n| Gruvbox Light | gruvbox-light-soft | light |\n| Horizon Bright | horizon-bright | light |\n| Kanagawa Lotus | kanagawa-lotus | light |\n| Night Owlish Light | night-owl-light | light |\n| Rose Pine Dawn | rose-pine-dawn | light |\n\n\u003c/details\u003e\n\n## Installation\n\nI recommend using [Quiver](https://github.com/freepicheep/quiver). If you have quiver installed, add this to your project with `qv add freepicheep/nu-doc-gen`. You can also install it globally with `qv add -g freepicheep/nu-doc-gen` and follow the instructions for adding the module to your `$env.NU_LIB_DIRS` so you can use it at any time.\n\n## Auto Deploy Using GitHub Actions\n\nThanks to Quiver's new `qvx` mode, you can use `nu-doc-gen` as a GitHub action to automatically deploy your module's docs to a GitHub page.\n\n```yaml\nname: Deploy Docs\n\non:\n  push:\n    branches:\n      - main\n  workflow_dispatch:\n\npermissions:\n  contents: read\n  pages: write\n  id-token: write\n\nconcurrency:\n  group: github-pages\n  cancel-in-progress: true\n\njobs:\n  build:\n    runs-on: ubuntu-latest\n\n    steps:\n      - name: Check out repository\n        uses: actions/checkout@v4\n\n      - name: Install Quiver\n        run: curl --proto '=https' --tlsv1.2 -LsSf https://github.com/freepicheep/quiver/releases/latest/download/quiver-installer.sh | sh\n\n      - name: Add Quiver to PATH\n        run: echo \"$HOME/.local/bin\" \u003e\u003e \"$GITHUB_PATH\"\n\n      - name: Build documentation site\n        run: qvx freepicheep/nu-doc-gen generate-doc-site \"${{ github.event.repository.name }}/\"\n\n      - name: Upload Pages artifact\n        uses: actions/upload-pages-artifact@v3\n        with:\n          path: site\n\n  deploy:\n    environment:\n      name: github-pages\n      url: ${{ steps.deployment.outputs.page_url }}\n    runs-on: ubuntu-latest\n    needs: build\n\n    steps:\n      - name: Deploy to GitHub Pages\n        id: deployment\n        uses: actions/deploy-pages@v4\n```\n\n## Examples\n\n- I built documentation for nu-doc-gen using itself. :) It's [here](https://freepicheep.github.io/nu-doc-gen/).\n- A more robust example for a Salesforce api wrapper: [nu-salesforce](https://freepicheep.github.io/nu-salesforce/)\n\n## Credit\n\n- I used LLMs extensively to help with the project.\n- The wonderful [Shiki](https://shiki.style/) project for Nu code block highlighting.\n- The wonderful [Fuse.js](https://www.fusejs.io/) for search.\n- [iTerm2-Color-Schemes](https://github.com/mbadolato/iTerm2-Color-Schemes) for the color palettes for the 43 supported themes.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffreepicheep%2Fnu-doc-gen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffreepicheep%2Fnu-doc-gen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffreepicheep%2Fnu-doc-gen/lists"}