# Standard Format for Tool Descriptions in Legendary OSINT Markdown Files > Learn the standard format for tool descriptions in Legendary OSINT markdown files. Discover the strict one-line pattern for efficient and clear documentation. - Repository: [Henri/Legendary_OSINT](https://github.com/K2SOsint/Legendary_OSINT) - Tags: best-practices - Published: 2026-08-09 --- **Legendary OSINT enforces a strict one-line markdown pattern for every tool entry: a hyphenated bullet containing the tool name as a clickable link, followed by an em-dash and a concise neutral description.** The Legendary OSINT repository maintains a comprehensive index of open-source intelligence tools across dozens of specialized categories. To guarantee consistency and enable automated parsing, the project mandates a specific standard format for tool descriptions across all documentation. This formatting specification is defined in the [`CONTRIBUTING.md`](https://github.com/K2SOsint/Legendary_OSINT/blob/main/CONTRIBUTING.md) file and applied uniformly to every entry in the `docs/` directory. ## The Core Markdown Syntax According to the Legendary OSINT source code, each tool entry must conform to a single-line bullet structure that separates the resource identity from its functional description. The required syntax follows this exact sequence: ```markdown - [Tool Name](https://tool-website.com) — Brief, neutral description. ``` This pattern initiates with a hyphen (`-`), wraps the tool name in standard markdown link syntax `[Name](URL)`, inserts an em-dash (`—`) as a separator, and concludes with a maximum one-sentence description ending in a period. ## Contributing Guidelines and Constraints The [`CONTRIBUTING.md`](https://github.com/K2SOsint/Legendary_OSINT/blob/main/CONTRIBUTING.md) file in the repository root defines seven strict rules governing the standard format for tool descriptions in Legendary OSINT: - **One-line limitation**: Each description must fit on a single line and contain at most one sentence. - **Bullet prefix**: All entries must start with a hyphen (`-`) followed by a space. - **Markdown links**: Tool names must be formatted as clickable markdown links, never as plain text or raw URLs. - **Em-dash separator**: An em-dash (`—`) is required between the closing parenthesis of the link and the first word of the description. - **Emoji prohibition**: Emojis are restricted to top-level headings only; tool entries must not contain graphical symbols or Unicode emoticons. - **Topic placement**: Entries belong in specific categorical files under the `docs/` directory (e.g., [`docs/search-engines.md`](https://github.com/K2SOsint/Legendary_OSINT/blob/main/docs/search-engines.md) for search utilities). - **Deduplication**: Contributors must verify the tool does not already exist elsewhere in the repository before submitting a new entry. ## Concrete Examples from the Source Code The following excerpts demonstrate how the standard format appears in production markdown files across different OSINT disciplines. ### Search Engine Entries In [`docs/search-engines.md`](https://github.com/K2SOsint/Legendary_OSINT/blob/main/docs/search-engines.md), entries follow the pattern precisely: ```markdown - [Google](https://www.google.com) — The most widely used web search engine ``` ### Video OSINT Tools The [`docs/video-osint.md`](https://github.com/K2SOsint/Legendary_OSINT/blob/main/docs/video-osint.md) file archives video analysis utilities using identical formatting: ```markdown - [yt‑dlp](https://github.com/yt-dlp/yt-dlp) — Download and archive YouTube and other videos ``` ### Infrastructure and Domain Research Infrastructure tools in [`docs/infra-domains.md`](https://github.com/K2SOsint/Legendary_OSINT/blob/main/docs/infra-domains.md) adhere to the same constraints: ```markdown - [DomainTools](https://domaintools.com) — Domain research platform ``` All three examples illustrate the repository-wide consistency: hyphenated bullet, linked tool name, em-dash separator, and concise functional description. ## Summary - Legendary OSINT requires a rigid one-line markdown format for every tool entry to ensure readability and machine parsing compatibility. - The mandatory syntax is `- [Name](URL) — Description.` featuring an em-dash separator and no trailing punctuation beyond the terminating period. - Source files in `docs/*.md` categorize tools by function while maintaining identical formatting standards defined in [`CONTRIBUTING.md`](https://github.com/K2SOsint/Legendary_OSINT/blob/main/CONTRIBUTING.md). - The format supports automated link validation and data extraction while remaining human-readable for OSINT researchers. ## Frequently Asked Questions ### What separator character must be used between the link and description? Legendary OSINT requires an **em-dash** (`—`, Unicode U+2014) immediately following the markdown link and preceding the description text. Standard hyphens or en-dashes are not acceptable substitutes in the standard format. ### Are emojis permitted in tool descriptions? No. The contributing guidelines explicitly prohibit emojis within bullet-point tool entries. Emojis are reserved exclusively for top-level section headings (e.g., `## ✈️ Aviation`), never inside the tool list items themselves. ### Where should new tool entries be placed? New entries must be added to the appropriate topical markdown file within the `docs/` directory, such as [`docs/search-engines.md`](https://github.com/K2SOsint/Legendary_OSINT/blob/main/docs/search-engines.md) for search utilities or [`docs/video-osint.md`](https://github.com/K2SOsint/Legendary_OSINT/blob/main/docs/video-osint.md) for video analysis tools. The root [`README.md`](https://github.com/K2SOsint/Legendary_OSINT/blob/main/README.md) serves only as a high-level index and does not contain individual tool entries. ### Why does the repository enforce this specific format? The strict standardization enables automated link checking, programmatic data extraction, and consistent rendering across different markdown parsers while maintaining optimal readability for researchers browsing the OSINT collection.