Adding a note
Quick method (recommended)
Section titled “Quick method (recommended)”- Duplicate the
_note-template.mdtemplate insrc/content/docs/fr/. - Rename the file after the topic (e.g.
python-f-strings.md). - Place it in the right category folder (or create a subfolder).
- Fill in the frontmatter:
titleanddescription. - Write the content in Markdown.
- Save, then
git add . && git commit -m "docs: new note ..." && git push.
A few minutes after the push, the note is live and indexed by search.
Note structure
Section titled “Note structure”---title: Note titledescription: One sentence describing the content (useful for search).---
Summary in 2-3 sentences of what you want to remember.
## Key points
- Point 1- Point 2
## Details
...
## References
- Useful link or sourceRules for finding things later
Section titled “Rules for finding things later”- One concept = one note. Split rather than pile up.
- Clear, precise titles. You’ll find them with search.
- Write for yourself in 6 months: context, examples, pitfalls.
- Add internal links to other notes:
[name](/fr/programming/...).