{"id":23141743,"url":"https://github.com/minicli/docs","last_synced_at":"2025-07-11T07:03:44.833Z","repository":{"id":37942735,"uuid":"266836878","full_name":"minicli/docs","owner":"minicli","description":"Minicli documentation and website","archived":false,"fork":false,"pushed_at":"2024-02-15T17:49:26.000Z","size":2139,"stargazers_count":19,"open_issues_count":2,"forks_count":11,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-06-30T20:46:14.247Z","etag":null,"topics":["command-line","command-line-app","hacktoberfest","hacktoberfest2021","php"],"latest_commit_sha":null,"homepage":"https://minicli.dev","language":"Dockerfile","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/minicli.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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}},"created_at":"2020-05-25T17:12:40.000Z","updated_at":"2023-06-04T12:18:30.000Z","dependencies_parsed_at":"2025-06-30T20:36:57.569Z","dependency_job_id":"2fe62b59-adb2-4618-8d20-b3829a75d49e","html_url":"https://github.com/minicli/docs","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/minicli/docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minicli%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minicli%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minicli%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minicli%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/minicli","download_url":"https://codeload.github.com/minicli/docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minicli%2Fdocs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264751945,"owners_count":23658520,"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":["command-line","command-line-app","hacktoberfest","hacktoberfest2021","php"],"created_at":"2024-12-17T14:14:18.963Z","updated_at":"2025-07-11T07:03:44.787Z","avatar_url":"https://github.com/minicli.png","language":"Dockerfile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Minicli Docs\n\nOfficial documentation repository for [minicli/minicli](https://github.com/minicli/minicli).\n\nThe documentation at [docs.minicli.dev](https://docs.minicli.dev) lives in the `docs` folder of this repository. The `landing` folder contains the landing page at [minicli.dev](https://minicli.dev).\n\n## Contributing\n\nCheck our [contributing guidelines](https://github.com/minicli/docs/blob/master/CONTRIBUTING.md) for details on how you can contribute to Minicli.\n\nBecause the documentation is built in markdown files, you can contribute directly from the GitHub website by accessing the documentation page you want to change and clicking on the pencil icon on the top right. This will automatically create a fork of the repository on your own GitHub profile, and upon committing your changes you'll be able to create a pull request directly.\n\n## Setting Up the Documentation Website\n\nThe documentation website is built with [MKDocs](https://www.mkdocs.org/) and hosted with [Read the Docs](https://readthedocs.org/).\n\n### Setting Up MKDocs Locally\n\nAlthough not necessary for contributing, in order to be able to run the documentation website locally and see your changes you'll need to set up MKDocs on your development machine. This will require:\n\n- Python 3\n- Pip\n\n#### Ubuntu/Debian systems\n\nMake sure you have python3 and pip installed:\n\n```shell\nsudo apt install python3 python3-pip\n```\n\nThen, install `mkdocs` and the `mkdocs-material` theme with:\n\n```shell\nsudo pip install mkdocs mkdocs-material\n```\n\nCheck if `mkdocs` was successfully installed with:\n\n```shell\nmkdocs --version\n```\n\nAfter cloning this repository, run the following command from the project's root folder: \n\n```shell\nmkdocs serve\n```\n\nThis command will block your terminal, serving the documentation website locally on `http://localhost:8000`. After making changes, you can simply reload the page to see your updates. When you are done, you can hit `CTRL+C` to stop serving the website. \n\nYou don't need to run the `build` command, since that is automatically run by Readthedocs when the main branch has new commits.\n\n#### macOS systems\n\nMake sure you have Homebrew installed:\n\n```shell\nruby -e \"$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)\"\n```\n\nThen install Python:\n\n```shell\nbrew install python\n```\n\nDownload the pip installer:\n\n```shell\ncurl https://bootstrap.pypa.io/get-pip.py -o get-pip.py\n```\n\nAnd run it, to install pip:\n\n```shell\npython3 get-pip.py\n```\n\nThen, install `mkdocs` and the `mkdocs-material` theme with:\n\n```shell\npip install mkdocs mkdocs-material\n```\n\n#### using Docker\n\nYou can use the provided Dockerfile to build a container that includes mkdocs and mkdocs-material, just follow the lines below.\n\nFirst, build the image using the following command from the project's root folder:\n```shell\ndocker build -t mkd:v1 .\n```\n\nThen, run the server\n```shell\ndocker run --rm -it -v \"$(pwd)\":/mkdocs/src -p 8080:8080 mkd:v1 mkdocs serve --dev-addr 0.0.0.0:8080\n```\n\nThis command will block your terminal. Now, you can open `http://localhost:8080` on your browser. After making changes, you can simply reload the page to see your updates. When you are done, you can hit `CTRL+C` to stop serving the website.\n\nYou don't need to run the `build` command, since that is automatically run by Readthedocs when the main branch has new commits.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fminicli%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fminicli%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fminicli%2Fdocs/lists"}