feat: scaffold howtos project
Collection of usage guides and cheatsheets. Includes project docs, topic template, and directory structure.
This commit is contained in:
23
docs/CHEATSHEET.md
Normal file
23
docs/CHEATSHEET.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# Cheatsheet
|
||||
|
||||
## Quick Reference
|
||||
|
||||
| Action | Command |
|
||||
|---------------------|--------------------------------------|
|
||||
| List topics | `ls topics/` |
|
||||
| Read topic | `bat topics/<name>.md` |
|
||||
| Add topic | `cp docs/TEMPLATE.md topics/<n>.md` |
|
||||
| Search across all | `grep -ri <term> topics/` |
|
||||
|
||||
## File Format
|
||||
|
||||
Each topic file follows `docs/TEMPLATE.md`:
|
||||
|
||||
```
|
||||
# <Topic>
|
||||
## Overview — one-liner description
|
||||
## Common Commands — daily-driver commands
|
||||
## Examples — real-world patterns
|
||||
## Gotchas — pitfalls and edge cases
|
||||
## See Also — related topics, links
|
||||
```
|
||||
23
docs/INSTALL.md
Normal file
23
docs/INSTALL.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# Install
|
||||
|
||||
## Prerequisites
|
||||
|
||||
None. This is a plain Markdown collection.
|
||||
|
||||
## Optional Tools
|
||||
|
||||
For better terminal rendering:
|
||||
|
||||
```bash
|
||||
# bat — syntax-highlighted cat
|
||||
sudo apt install bat
|
||||
|
||||
# glow — terminal markdown renderer
|
||||
sudo apt install glow
|
||||
```
|
||||
|
||||
## Clone
|
||||
|
||||
```bash
|
||||
git clone <repo-url> ~/git/howtos
|
||||
```
|
||||
26
docs/TEMPLATE.md
Normal file
26
docs/TEMPLATE.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# Topic Name
|
||||
|
||||
> One-line description of what this tool/subject is.
|
||||
|
||||
## Common Commands
|
||||
|
||||
```bash
|
||||
# description
|
||||
command --flag argument
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```bash
|
||||
# Practical example with context
|
||||
command --option value
|
||||
```
|
||||
|
||||
## Gotchas
|
||||
|
||||
- Known pitfall or surprising behavior
|
||||
|
||||
## See Also
|
||||
|
||||
- `related-topic` — brief note
|
||||
- [External reference](https://example.com)
|
||||
29
docs/USAGE.md
Normal file
29
docs/USAGE.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# Usage
|
||||
|
||||
## Browsing Topics
|
||||
|
||||
Each topic is a standalone Markdown file in `topics/`:
|
||||
|
||||
```bash
|
||||
# List available topics
|
||||
ls topics/
|
||||
|
||||
# Read a topic in terminal
|
||||
cat topics/git.md # plain
|
||||
bat topics/git.md # syntax highlighted
|
||||
glow topics/git.md # rendered markdown
|
||||
```
|
||||
|
||||
## Adding a New Topic
|
||||
|
||||
```bash
|
||||
cp docs/TEMPLATE.md topics/<name>.md
|
||||
```
|
||||
|
||||
Edit the file following the template structure. Keep it under 200 lines.
|
||||
|
||||
## Naming Conventions
|
||||
|
||||
- Lowercase, hyphenated: `docker-compose.md`, `git-rebase.md`
|
||||
- One topic per file
|
||||
- Use the tool/subject name as the filename
|
||||
Reference in New Issue
Block a user