{"id":13550730,"url":"https://github.com/docxy/docxy","last_synced_at":"2025-05-01T15:30:24.640Z","repository":{"id":57188119,"uuid":"188604463","full_name":"docxy/docxy","owner":"docxy","description":"The CLI for Docxy.","archived":false,"fork":false,"pushed_at":"2020-11-24T06:09:29.000Z","size":73,"stargazers_count":13,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-06T15:06:12.357Z","etag":null,"topics":["awesomedocs","cli","command-line-interface","docxy","hacktoberfest"],"latest_commit_sha":null,"homepage":"https://docxy.traction.one/cli","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/docxy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":["k3rn31p4nic"],"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":["https://paypal.me/snkrsnkampa"]}},"created_at":"2019-05-25T19:25:09.000Z","updated_at":"2021-11-15T13:35:10.000Z","dependencies_parsed_at":"2022-08-28T10:51:41.220Z","dependency_job_id":null,"html_url":"https://github.com/docxy/docxy","commit_stats":null,"previous_names":["awesomedocs/cli"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docxy%2Fdocxy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docxy%2Fdocxy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docxy%2Fdocxy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docxy%2Fdocxy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/docxy","download_url":"https://codeload.github.com/docxy/docxy/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251898496,"owners_count":21661837,"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":["awesomedocs","cli","command-line-interface","docxy","hacktoberfest"],"created_at":"2024-08-01T12:01:36.754Z","updated_at":"2025-05-01T15:30:24.396Z","avatar_url":"https://github.com/docxy.png","language":"Go","funding_links":["https://github.com/sponsors/k3rn31p4nic","https://paypal.me/snkrsnkampa"],"categories":["Go","cli"],"sub_categories":[],"readme":"# Docxy CLI\n\nThis is a CLI for [Docxy](https://docxy.traction.one).\n\nDocxy is a React based open-source documentation site\ngenerator. Build beautiful, blazing fast documentation sites\nfor your projects with just markdown.\n\nThe Docxy CLI is used to:\n- Create and initialize a Docxy application\n- Spin up a hot-reloading local development server\n- Build a production-ready website ready for deployment\n\n\n## Installation\n\nYou can install the Docxy CLI in one of the two ways\nmentioned below.\n\n### Option 1 - Install from Source\n\n\u003e Note that, you need to have [Go](https://golang.org)\n\u003e installed for this.\n\nYou can directly install it from source simply by running\nthe following command:\n\n```bash\ngo get -u github.com/docxy/docxy\n```\n\nThis will automatically install `docxy` globally.\n\n### Option 2 - Get Binaries\n\nYou can directly get the updated version of the Docxy CLI\nbinaries from [GitHub Releases](https://github.com/docxy/docxy/releases),\nand place it somewhere in your `$PATH` so that you can access the `docxy`\ncommand from anywhere.\n\n\n## Usage\n\nAfter installation, it can be accessed globally using the\n`docxy` command.\n\n```\nUsage:\n  docxy [command]\n\nAvailable Commands:\n  help        Help about any command\n  create      Creates a Docxy project\n  init        Initializes a Docxy project\n  serve       Starts the development server\n  build       Builds the Docxy website\n\nFlags:\n  -h, --help   help for docxy\n\nUse \"docxy [command] --help\" for more information about a command.\n```\n\n## Contributing\n\nAny and all contributions are welcomed.\n\nIf you want to contribute code, you need to have a\ndevelopment environment set up for working with Go.\n\n## License\n\nCopyright © 2020 Sankarsan Kampa\n\nThis Source Code Form is subject to the terms of the Mozilla Public\nLicense, v. 2.0. If a copy of the MPL was not distributed with this\nfile, You can obtain one at https://mozilla.org/MPL/2.0/.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocxy%2Fdocxy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdocxy%2Fdocxy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocxy%2Fdocxy/lists"}