diff options
author | 2022-12-11 11:44:04 -0500 | |
---|---|---|
committer | 2022-12-11 11:44:04 -0500 | |
commit | 63f1d78927626ef2f5c0d81e6283dee73ac7c167 (patch) | |
tree | 3780662851d0c69c800a69800a29e5680de26734 /pydis_site/apps/content | |
parent | Merge pull request #811 from python-discord/dependabot/pip/flake8-bugbear-22.... (diff) |
Add tips that showcase markdown quirks.
Diffstat (limited to 'pydis_site/apps/content')
-rw-r--r-- | pydis_site/apps/content/resources/guides/pydis-guides/how-to-contribute-a-page.md | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/pydis_site/apps/content/resources/guides/pydis-guides/how-to-contribute-a-page.md b/pydis_site/apps/content/resources/guides/pydis-guides/how-to-contribute-a-page.md index 716250b1..4639b4d2 100644 --- a/pydis_site/apps/content/resources/guides/pydis-guides/how-to-contribute-a-page.md +++ b/pydis_site/apps/content/resources/guides/pydis-guides/how-to-contribute-a-page.md @@ -215,3 +215,44 @@ To use a custom label in the table of contents for a heading, set the `data-toc- ```markdown # Header 1 {: data-toc-label="Header One" } ``` + +## Tips + +### Nested/Unhighlighted Code Blocks +To nest code blocks, increase the number of ticks in the outer block by 1. To remove highlighting from code blocks (ie. no dark background), you can use the `nohighlight` language. +`````nohighlight +````nohighlight +```python +print("Some inner code block text.") +``` +```` +````` + +### Images in Lists +To properly indent images in lists, keep the image on the line directly after the previous line and add `<br>` to the end of the text, like this: + +```markdown +1. List item text one.<br> + + +2. List item text two.<br> + +``` + +### Keeping Text In The Same Paragraph +You can also use `<br>` to break lines while keeping them in the same paragraph (avoiding the vertical spacing added between paragraphs). + +```nohighlight +##### Same line, same paragraph +Line A +Line B + +##### Different line, different paragraph +Line A + +Line B + +##### Different line, same paragraph +Line A<br> +Line B +``` |