pmt_domentation
v1.0.1
Published
Projet isole pour documenter n'importe quel projet avec LaTeX, Docker, captures de code et templates.
Readme
Documentaion_des_projet
Projet isole pour produire la documentation de n'importe quel projet avec:
- LaTeX en direct dans VS Code;
- Docker / DevContainer;
- captures de code stylisees;
- captures reelles de fenetre VS Code;
- templates reutilisables (rapport, memoire).
Objectif
Standardiser la documentation technique et academique sans dependre de la stack du projet cible.
Structure
Documentaion_des_projet/
.devcontainer/
.vscode/
docs/
scripts/
templates/
package.jsonDemarrage rapide
Mode universel recommande (Windows/Linux/macOS) avec Docker:
npm run doc:init:report
# ou
npm run doc:init:memoire
npm run doc:buildMode local (si LaTeX deja installe): npm run build
PDF genere:
docs/build/main.pdf- lien rapide:
docs/main.pdf
Scripts packagiste (npm)
npm run doctor: verifier l'environnementnpm run doc:init:report: init template report via Dockernpm run doc:init:memoire: init template memoire via Dockernpm run doc:build: build PDF via Dockernpm run doc:watch: watch PDF via Dockernpm run doc:clean: clean via Dockernpm run build: compilation PDFnpm run watch: compilation continuenpm run clean: nettoyage auxiliairesnpm run template:list: liste templatesnpm run template:init:report: applique template rapportnpm run template:init:memoire: applique template memoirenpm run capture:code -- <fichier> <debut> <fin> <sortie.png>npm run capture:vscode -- --source <fichier> --line <n> --output <png>
Captures
Capture code stylisee
npm run capture:code -- src/app.ts 10 80 docs/captures/app-ts.pngCapture VS Code reelle
npm run capture:vscode -- \
--source /chemin/projet/src/app.ts \
--line 120 \
--output docs/captures/reelle-vscode.pngPrerequis hote (Linux)
sudo apt update
sudo apt install -y wmctrl xdotool x11-utils python3-pilReference complete
Voir le guide complet:
DOCUMENTATION_COMPLETE_LATEX_DOCKER_VSCODE.md
