Repository navigation
project-documentation
- Website
- Wikipedia
📢 Various README templates & tips on writing high-quality documentation that people want to read.
💻🔥CLI to generate the recommended documentation/files to improve contribution (Github, Gitlab, CodeCommit and Bitbucket)
📖 Highly customizable Project Docs / Wiki / Knowledge Base / Notes template for Hugo Website Builder. 创建项目文档
A template README for projects <img alt="octocat" src="https://github.githubassets.com/images/icons/emoji/octocat.png?v8" />
This open-source npm package leverages AI to analyze your project structure and automatically generate a professional, detailed, and SEO-friendly README file. It simplifies documentation by creating sections for installation, usage, features, and more—all tailored to your project. Perfect for developers looking to enhance project visibility.
here is a comprehensive list of Markdown syntax along with examples for use in your README.md file, including Mermaid diagrams and code blocks for various programming languages.
Template repository aiming creation of the runbooks combined with basic lightweight documentation portal based on mkdocs, plantuml diagrams, and set of selected plugins
This repository contain some papers on indoor navigation. We used these papers to built a small model of indoor navigation which is fast and efficient. Documentation and python code of the project is given in the form of word document.
CodebaseMD: VS Code extension to export your codebase or selected files as a structured Markdown document, ideal for documentation, code sharing, and project overviews.
My personal GitHub Pages website (theme forked from Chirpy)
A automated way to create project's document for Ineuron Portal Projects.
The overall objective of this project is to provide a ready-to-use documentation model with English/French bilingual parameters and versioning parameters.
collection of catalog and open layer (eps file -use Adobe Illustrator) files useful to create project catalog.
Repository for storing practice results in the Learning Intermediate Android Application Development class on Dicoding
A example of project docs using docsify, and a tool to automate implementing project docs
Interactive documentation generator that creates comprehensive markdown docs with project trees, TOC, and code navigation.