Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jekwwer/markdown-docs-kit

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.
https://github.com/jekwwer/markdown-docs-kit

devcontainer documentation documentation-generator markdown mkdocs mkdocs-material template templates

Last synced: 2 days ago
JSON representation

Host: GitHub
URL: https://github.com/jekwwer/markdown-docs-kit
Owner: Jekwwer
License: other
Created: 2025-02-05T14:43:56.000Z (10 days ago)
Default Branch: main
Last Pushed: 2025-02-13T00:37:22.000Z (2 days ago)
Last Synced: 2025-02-13T01:28:45.883Z (2 days ago)
Topics: devcontainer, documentation, documentation-generator, markdown, mkdocs, mkdocs-material, template, templates
Language: JavaScript
Homepage: https://jekwwer.github.io/markdown-docs-kit/
Size: 651 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

README

        # Markdown Docs Kit

![GitHub Release](https://img.shields.io/github/v/release/Jekwwer/markdown-docs-kit?logo=github&link=https%3A%2F%2Fgithub.com%2FJekwwer%2Fmarkdown-docs-kit%2Freleases%2Flatest)

![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)

![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)

![Libraries.io dependency status for GitHub repo](https://img.shields.io/librariesio/github/Jekwwer/markdown-docs-kit?logo=librariesdotio&logoColor=%23FFFFFF)

![Issues](https://img.shields.io/github/issues/Jekwwer/markdown-docs-kit?logo=github&link=https%3A%2F%2Fgithub.com%2FJekwwer%2Fmarkdown-docs-kit%2Fissues)

![Maintained](https://img.shields.io/maintenance/yes/2025)

![License: CC BY 4.0](https://img.shields.io/badge/License-CC%20BY%204.0-blue.svg)

## Project Overview 🚀

This repository contains common documentation files that can be reused across multiple projects

to maintain consistency and streamline the setup process.

### Current Contents

- `.github/FUNDING.yml`: Information on funding options and sponsorship links.

- `.github/PULL_REQUEST_TEMPLATE.md`: Default pull request template for general contributions.

- `.github/PULL_REQUEST_TEMPLATE/*`: Templates for specific pull requests, such as `bugfix`, `docs`, and `feature`.

- `.github/ISSUE_TEMPLATE/*`: Templates for reporting bugs, requesting features, and asking questions.

- `CODE_OF_CONDUCT.md`: Standards for behavior within the community.

- `CONTRIBUTING.md`: Guidelines on how to contribute to the project.

- `README.md`: A general template for project README, outlining setup instructions, usage,

  and contribution guidelines.

- `SCHOOL_PROJECT_README.md`: A specialized README template for educational or school-related projects.

- `SECURITY.md`: Guidelines for securely reporting vulnerabilities and related contact details.

- `STYLEGUIDE.md`: Coding and documentation conventions for consistency and maintainability.

## License 🛡️

This repository is licensed under **Creative Commons Attribution 4.0 (CC BY 4.0)**

for the Markdown templates located in the [`templates`][TEMPLATES_DIR] directory.

You **must** provide attribution when using them (see [`LICENSE`][LICENSE]).

The development environment (scripts, configuration, and tooling) is based on

[markdown-workspace][jekwwer-markdown-workspace] and is licensed under **MIT** (see [`MIT-LICENSE`][MIT_LICENSE]).

## Usage 🛠️

Clone the repository and copy the required documentation files:

```bash

git clone https://github.com/Jekwwer/markdown-docs-kit.git

```

Then customize the necessary files for your project.

## Contributing 👥

Contributions are welcome! Please read the [Contributing Guidelines][CONTRIBUTING] and check the [Issues][issues] page.

## Contact 📬

For questions, reach out via [[email protected]][[email protected]] or open an [issue][issues].

---

### Notes

This repository is synchronized with the [Markdown Workspace][jekwwer-markdown-workspace],

currently at version [v1.6.0][jekwwer-markdown-workspace-v1.6.0].

The repository serves as a development foundation for working on markdown documentation effectively.

---

This document is based on a template by [Evgenii Shiliaev][evgenii-shiliaev-github], licensed under [CC BY 4.0][jekwwer-markdown-docs-kit-license].

All additional content is licensed under [MIT][MIT_LICENSE].

[CONTRIBUTING]: CONTRIBUTING.md

[LICENSE]: LICENSE

[MIT_LICENSE]: MIT-LICENSE

[TEMPLATES_DIR]: templates/

[evgenii-shiliaev-github]: https://github.com/Jekwwer

[[email protected]]: mailto:[email protected]

[issues]: https://github.com/Jekwwer/markdown-docs-kit/issues

[jekwwer-markdown-docs-kit-license]: https://github.com/Jekwwer/markdown-docs-kit/blob/main/LICENSE

[jekwwer-markdown-workspace]: https://github.com/Jekwwer/markdown-workspace

[jekwwer-markdown-workspace-v1.6.0]: https://github.com/Jekwwer/markdown-workspace/tree/v1.6.0