jeroenouw / Cgx
Licence: other
π»π₯CLI to generate the recommended documentation/files to improve contribution (Github, Gitlab, CodeCommit and Bitbucket)
Stars: β 190
Programming Languages
typescript
32286 projects
Labels
Projects that are alternatives of or similar to Cgx
Assemble
Community
Stars: β 3,995 (+2002.63%)
Mutual labels: documentation, markdown, generator, templates
Sourcedocs
Generate Markdown documentation from source code
Stars: β 286 (+50.53%)
Mutual labels: documentation, documentation-generator, markdown, generator
Jsdoc To Markdown
Generate markdown documentation from jsdoc-annotated javascript
Stars: β 1,199 (+531.05%)
Mutual labels: documentation, documentation-generator, markdown, generator
Verb
HEADS UP! Verb is going though a major transition, we've completely refactored everything from the ground up. If you're interested, please see the dev branch.
Stars: β 442 (+132.63%)
Mutual labels: documentation, markdown, generator
Md To Pdf
Hackable CLI tool for converting Markdown files to PDF using Node.js and headless Chrome.
Stars: β 374 (+96.84%)
Mutual labels: cli, documentation, markdown
Swaggen
OpenAPI/Swagger 3.0 Parser and Swift code generator
Stars: β 385 (+102.63%)
Mutual labels: cli, generator, template
Pydoc Markdown
Create Python API documentation in Markdown format.
Stars: β 273 (+43.68%)
Mutual labels: cli, documentation-generator, markdown
Easybook
Book publishing as easy as it should be (built with Symfony components)
Stars: β 744 (+291.58%)
Mutual labels: documentation, markdown, generator
Contributing Template
Template for writing your own contributing guide
Stars: β 565 (+197.37%)
Mutual labels: community, documentation, template
Git Repo
Git-Repo: CLI utility to manage git services from your workspace
Stars: β 818 (+330.53%)
Mutual labels: cli, gitlab, bitbucket
The forge
Our groundbreaking, lightning fast PWA CLI tool
Stars: β 70 (-63.16%)
Mutual labels: aws, cli, generator
Reviewdog
πΆ Automated code review tool integrated with any code analysis tools regardless of programming language
Stars: β 4,541 (+2290%)
Mutual labels: cli, gitlab, bitbucket
Serverless Aws Documentation
Serverless 1.0 plugin to add documentation and models to the serverless generated API Gateway
Stars: β 299 (+57.37%)
Mutual labels: aws, documentation, documentation-generator
Docsify Tabs
A docsify.js plugin for rendering tabbed content from markdown
Stars: β 65 (-65.79%)
Mutual labels: documentation, markdown, generator
Flybook
βοΈ FlyBook is a simple utility to generate static website such as gh-pages, manual of you projects
Stars: β 76 (-60%)
Mutual labels: cli, documentation, markdown
Pdoc
π β‘οΈ π Auto-generate API documentation for Python projects
Stars: β 604 (+217.89%)
Mutual labels: documentation, documentation-generator, generator
Extension Create
Create modern cross-browser extensions with no build configuration.
Stars: β 167 (-12.11%)
Mutual labels: cli, generator, template
github-templates
Good templates for the issue, pull request, and contributing templates on GitHub, GitLab, and Bitbucket.
Stars: β 65 (-65.79%)
Mutual labels: gitlab, templates, bitbucket
Trackdown
TrackDown - Issue Tracking with plain Markdown. If you are missing the "git clone" for your tickets from github.com or bitbucket.org, then this is for you. A lightweight Ticketing System for distributed and unconnected small Teams.
Stars: β 10 (-94.74%)
Mutual labels: markdown, gitlab, bitbucket
Git Copy History
Copy commit history from another repository
Stars: β 84 (-55.79%)
Mutual labels: cli, gitlab, bitbucket
CGX - CLI to Generate recommended documentation/files to improve contribution
Do you want people to contribute to your project? Make it easy for your contributors. Generate all the recommended documentation/files (pre-filled) for the Github and Gitlab community standards. Files for CodeCommit (AWS) or Bitbucket can be generated too. This project has 99+% type coverage checked by tscov.
Generate multiple files at once
Generate a license
Files that can be generated
More files & providers in future versions.
Github, Gitlab, CodeCommit and Bitbucket
- License
- MIT
- ISC
- Apache 2.0
- BSD 2-Clause
- GPLv3
- CCOv1
- Changelog
- Contributing
- Readme
- Todo
- Code of Conduct
- Dockerfile
Github specific
- Bug report (issue)
- Security vulnerability report
- Feature request (issue)
- Pull request template
- All files at once
Gitlab specific
- CI template
- Bug (issue)
- Feature proposal (issue)
- Merge request
- All files at once
CodeCommit specific
- Buildspec (AWS CodeBuild)
- Appspec (AWS CodeDeploy)
- All files at once
Bitbucket specific
- In future versions
Useful for every project
- Existing or new
- Large or small
- Every language
- Github, Gitlab, CodeCommit (AWS) or Bitbucket
Quickstart
Install the CGX CLI as a global CLI.
npm install -g cgx
cd <your-repo-location>
# Then you run
cgx
Or just use via npx:
cd <your-repo-location>
# Then you run
npx cgx
This should start the CLI and ask for questions about which files you want to add!
Example
Generate all Github files example:
____ ____ __ __
/ ___| / ___| \ \/ /
| | | | _ \ /
| |___ | |_| | / \
\____| \____| /_/\_\
Generate all the recommended markdown documentation/templates for the Github and Gitlab community standards.
Files for CodeCommit (AWS) or Bitbucket can be generated too
? Select a Git hosting provider: Github
? Which Github files do you want to generate? All recommended files (other files can be generated separate)
INFO: Start generating all recommended files...
GENERATE: CODE_OF_CONDUCT.md...
GENERATE: CONTRIBUTING.md...
GENERATE: bug_report.md...
GENERATE: feature_request.md...
GENERATE: pull_request_template.md...
CREATE: bug_report.md in .github/ISSUE_TEMPLATE/bug_report.md
CREATE: CODE_OF_CONDUCT.md.md
CREATE: CONTRIBUTING.md
CREATE: feature_request.md in .github/ISSUE_TEMPLATE/feature_request.md
CREATE: pull_request_template.md in .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
Git provider question:
? Select a Git hosting provider: (Use arrow keys)
β― Github
Gitlab
CodeCommit (AWS)
Bitbucket
Generate file question:
? Which Gitlab files do you want to generate? (Use arrow keys)
β― All recommended files (other files can be generated separate)
License
Changelog
Code of conduct
Contributing
Bug report (issue)
Feature request (issue)
Pull request template
Readme
Todo
Dockerfile
Generate license example:
? Select a Git hosting provider: Github
? Which Gtihub files do you want to generate? License
GENERATE: LICENSE...
? Which type of license do you want to generate? MIT License
? Please fill in your Git username: Jeroenouw
CREATE: LICENSE
File already exists example:
? Select a Git hosting provider: Bitbucket
? Which Bitbucket files do you want to generate? Contributing
GENERATE: CONTRIBUTING.md...
? This file already exists. Do you want to overwrite it? Yes
UPDATE: CONTRIBUTING.md
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].