{"id":25308575,"url":"https://github.com/jekwwer/markdown-docs-kit","last_synced_at":"2025-04-07T08:36:47.756Z","repository":{"id":276022420,"uuid":"927786089","full_name":"Jekwwer/markdown-docs-kit","owner":"Jekwwer","description":"A collection of reusable Markdown templates and automated deployment scripts designed to standardize and streamline documentation across projects. Built on top of markdown-workspace, this repository includes templates for README, Code of Conduct, Contributing Guidelines, and more.","archived":false,"fork":false,"pushed_at":"2025-04-01T23:54:18.000Z","size":844,"stargazers_count":0,"open_issues_count":5,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-06T07:56:43.447Z","etag":null,"topics":["devcontainer","documentation","documentation-generator","markdown","mkdocs","mkdocs-material","template","templates"],"latest_commit_sha":null,"homepage":"https://jekwwer.github.io/markdown-docs-kit/","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Jekwwer.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"jekwwer","buy_me_a_coffee":"jekwwer","ko_fi":"jekwwer","liberapay":"jekwwer","open_collective":"jekwwer","patreon":"jekwwer"}},"created_at":"2025-02-05T14:43:56.000Z","updated_at":"2025-03-23T14:41:22.000Z","dependencies_parsed_at":"2025-03-19T05:23:16.030Z","dependency_job_id":"151dd3ad-8922-4b5e-9b5f-228cf4df8642","html_url":"https://github.com/Jekwwer/markdown-docs-kit","commit_stats":null,"previous_names":["jekwwer/markdown-docs-kit"],"tags_count":9,"template":false,"template_full_name":"Jekwwer/markdown-workspace","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jekwwer%2Fmarkdown-docs-kit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jekwwer%2Fmarkdown-docs-kit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jekwwer%2Fmarkdown-docs-kit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jekwwer%2Fmarkdown-docs-kit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Jekwwer","download_url":"https://codeload.github.com/Jekwwer/markdown-docs-kit/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247622594,"owners_count":20968565,"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":["devcontainer","documentation","documentation-generator","markdown","mkdocs","mkdocs-material","template","templates"],"created_at":"2025-02-13T12:23:49.954Z","updated_at":"2025-04-07T08:36:47.750Z","avatar_url":"https://github.com/Jekwwer.png","language":"Shell","funding_links":["https://github.com/sponsors/jekwwer","https://buymeacoffee.com/jekwwer","https://ko-fi.com/jekwwer","https://liberapay.com/jekwwer","https://opencollective.com/jekwwer","https://patreon.com/jekwwer"],"categories":[],"sub_categories":[],"readme":"# Markdown Docs Kit\n\n![GitHub Release](https://img.shields.io/github/v/release/Jekwwer/markdown-docs-kit?logo=github\u0026link=https%3A%2F%2Fgithub.com%2FJekwwer%2Fmarkdown-docs-kit%2Freleases%2Flatest)\n![GitHub Release Date](https://img.shields.io/github/release-date/Jekwwer/markdown-docs-kit?link=https%3A%2F%2Fgithub.com%2FJekwwer%2Fmarkdown-docs-kit%2Freleases%2Flatest)\n![GitHub commits since latest release](https://img.shields.io/github/commits-since/Jekwwer/markdown-docs-kit/latest?link=https%3A%2F%2Fgithub.com%2FJekwwer%2Fmarkdown-docs-kit%2Freleases%2Flatest)\n![Libraries.io dependency status for GitHub repo](https://img.shields.io/librariesio/github/Jekwwer/markdown-docs-kit?logo=librariesdotio\u0026logoColor=%23FFFFFF)\n![Issues](https://img.shields.io/github/issues/Jekwwer/markdown-docs-kit?logo=github\u0026link=https%3A%2F%2Fgithub.com%2FJekwwer%2Fmarkdown-docs-kit%2Fissues)\n![Maintained](https://img.shields.io/maintenance/yes/2025)\n![License: CC BY 4.0](https://img.shields.io/badge/License-CC%20BY%204.0-blue.svg)\n\n## Project Overview 🚀\n\nThis repository contains common documentation files that can be reused across multiple projects\nto maintain consistency and streamline the setup process.\n\n### Current Contents\n\n- `.github/FUNDING.yml`: Information on funding options and sponsorship links.\n- `.github/PULL_REQUEST_TEMPLATE.md`: Default pull request template for general contributions.\n- `.github/PULL_REQUEST_TEMPLATE/*`: Templates for specific pull requests, such as `bugfix`, `docs`, and `feature`.\n- `.github/ISSUE_TEMPLATE/*`: Templates for reporting bugs, requesting features, and asking questions.\n- `CODE_OF_CONDUCT.md`: Standards for behavior within the community.\n- `CONTRIBUTING.md`: Guidelines on how to contribute to the project.\n- `README.md`: A general template for project README, outlining setup instructions, usage,\n  and contribution guidelines.\n- `SCHOOL_PROJECT_README.md`: A specialized README template for educational or school-related projects.\n- `SECURITY.md`: Guidelines for securely reporting vulnerabilities and related contact details.\n- `STYLEGUIDE.md`: Coding and documentation conventions for consistency and maintainability.\n\n## Prerequisites ⚙️\n\nMake sure the following tools are installed on your system:\n\n- `curl`\n- `unzip`\n- [`jq`][jq-web]\n- [`yq`][yq-git]\n\n## Usage 🛠️\n\n### Run the Deployment Script\n\nExecute the `deploy.sh` script to download the latest documentation and apply configurations:\n\n```bash\nbash deploy.sh --target \u003ctarget_directory\u003e [--config \u003cpath_to_config.yml\u003e]\n```\n\n**Options:**\n\n- `--target \u003ctarget_directory\u003e`: Specifies where the documentation will be deployed.\n- `--config \u003cpath_to_config.yml\u003e` _(optional)_: Path to a custom configuration file.\n  Defaults to `config.yml` in the current directory.\n- Additionally, you can override repository details using `--repo-owner` and `--repo-name` if necessary.\n\n### Manual Setup (Optional)\n\nIf you prefer, manually clone the repository and copy the required documentation files:\n\n```bash\ngit clone https://github.com/Jekwwer/markdown-docs-kit.git\n```\n\nThen customize the necessary files for your project.\n\n### Example Deployment\n\nTo deploy documentation to a new repository:\n\n```bash\nbash deploy.sh --target ../my-new-repo\n```\n\nThis will:\n\n- Fetch the latest release.\n- Replace placeholders using `config.yml`.\n- Deploy files to `../my-new-repo`, maintaining the folder structure.\n\n## Potential Future Documents 📜\n\nThis table serves as a reference for adding new documents to meet future project requirements as they arise.\n\n| **Document Name**      | **Purpose**                                                                             |\n| ---------------------- | --------------------------------------------------------------------------------------- |\n| **ACKNOWLEDGMENTS.md** | Recognizes contributions from libraries, frameworks, or individuals.                    |\n| **ARCHITECTURE.md**    | Offers an overview of the project’s structure and design decisions.                     |\n| **BUILD.md**           | Instructions for building the project, including dependencies and troubleshooting.      |\n| **CONFIG.md**          | Documents configuration options, environment variables, and setup instructions.         |\n| **CONTRIBUTING.md**    | Guidelines for contributing to the project: coding standards, PRs, and issue reports.   |\n| **CONVENTIONS.md**     | Describes naming patterns, coding standards, or folder structures for consistency.      |\n| **DEPENDENCIES.md**    | Lists key dependencies and their versions for compatibility insights.                   |\n| **FAQ.md**             | Answers frequently asked questions to save time and clarify common concerns.            |\n| **GLOSSARY.md**        | Defines domain-specific terms and abbreviations for clarity.                            |\n| **GOVERNANCE.md**      | Outlines roles, responsibilities, and decision-making processes for maintainers.        |\n| **INSTALL.md**         | Detailed installation instructions for projects with complex setup requirements.        |\n| **MIGRATION_GUIDE.md** | Helps users upgrade between major versions by detailing changes and migration steps.    |\n| **ROADMAP.md**         | Provides insights into the project’s future direction and priorities.                   |\n| **RELEASE.md**         | Instructions for managing and packaging project releases.                               |\n| **SUPPORT.md**         | Provides resources for getting help, including forums, FAQs, or troubleshooting guides. |\n| **TESTING.md**         | Explains testing frameworks, setup, and commands for running tests.                     |\n| **TODO.md**            | Lists future plans, pending features, or unresolved issues for transparency.            |\n| **USAGE.md**           | Advanced usage examples, command-line options, or API details.                          |\n\n## Contributing 👥\n\nContributions are welcome! Please read the [Contributing Guidelines][CONTRIBUTING] and check the [Issues][issues] page.\n\n## License 🛡️\n\nThis repository is licensed under **Creative Commons Attribution 4.0 (CC BY 4.0)**\nfor the Markdown templates located in the [`templates`][TEMPLATES_DIR] directory.\nYou **must** provide attribution when using them (see [`LICENSE`][LICENSE]).\n\nThe development environment (scripts, configuration, and tooling) is based on\n[markdown-workspace][jekwwer-markdown-workspace] and is licensed under **MIT** (see [`MIT-LICENSE`][MIT_LICENSE]).\n\n## Contact 📬\n\nFor questions, reach out via [evgenii.shiliaev@jekwwer.com][evgenii.shiliaev@jekwwer.com] or open an [issue][issues].\n\n---\n\n### Notes\n\nThis repository is synchronized with the [Markdown Workspace][jekwwer-markdown-workspace],\ncurrently at version [v1.6.0][jekwwer-markdown-workspace-v1.6.0].\nThe repository serves as a development foundation for working on markdown documentation effectively.\n\n---\n\nThis document is based on a template by [Evgenii Shiliaev][evgenii-shiliaev-github], licensed under [CC BY 4.0][jekwwer-markdown-docs-kit-license].\nAll additional content is licensed under [MIT][MIT_LICENSE].\n\n[CONTRIBUTING]: CONTRIBUTING.md\n[LICENSE]: LICENSE\n[MIT_LICENSE]: MIT-LICENSE\n[TEMPLATES_DIR]: templates/\n[evgenii-shiliaev-github]: https://github.com/Jekwwer\n[evgenii.shiliaev@jekwwer.com]: mailto:evgenii.shiliaev@jekwwer.com\n[issues]: https://github.com/Jekwwer/markdown-docs-kit/issues\n[jekwwer-markdown-docs-kit-license]: https://github.com/Jekwwer/markdown-docs-kit/blob/main/LICENSE\n[jekwwer-markdown-workspace]: https://github.com/Jekwwer/markdown-workspace\n[jekwwer-markdown-workspace-v1.6.0]: https://github.com/Jekwwer/markdown-workspace/tree/v1.6.0\n[jq-web]: https://stedolan.github.io/jq\n[yq-git]: https://github.com/mikefarah/yq\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjekwwer%2Fmarkdown-docs-kit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjekwwer%2Fmarkdown-docs-kit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjekwwer%2Fmarkdown-docs-kit/lists"}