From 63f1d78927626ef2f5c0d81e6283dee73ac7c167 Mon Sep 17 00:00:00 2001 From: kosayoda Date: Sun, 11 Dec 2022 11:44:04 -0500 Subject: Add tips that showcase markdown quirks. --- .../pydis-guides/how-to-contribute-a-page.md | 41 ++++++++++++++++++++++ 1 file changed, 41 insertions(+) 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 `
` to the end of the text, like this: + +```markdown +1. List item text one.
+![Image text one](image/link/one) + +2. List item text two.
+![Image text two](image/link/two) +``` + +### Keeping Text In The Same Paragraph +You can also use `
` 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
+Line B +``` -- cgit v1.2.3 From 7f80bdcf2f7ca862570cfa0c78ee7a2b764ac2fa Mon Sep 17 00:00:00 2001 From: kosayoda Date: Sun, 11 Dec 2022 11:46:54 -0500 Subject: Point showcase link to an actual example. The example pointed to by the previous link is no more, so let's find another example. --- .../content/resources/guides/pydis-guides/how-to-contribute-a-page.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 4639b4d2..0d14ef41 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 @@ -169,7 +169,7 @@ path = os.path.join("foo", "bar") ### HTML Attributes To add HTML attributes to certain lines/paragraphs, [see this page](https://python-markdown.github.io/extensions/attr_list/#the-list) for the format and where to put it. -This can be useful for setting the image size when adding an image using markdown (see the [Image Captions](#image-captions) section for an example), or for adding bulma styles to certain elements (like the warning notification [here](/pages/guides/pydis-guides/contributing/sir-lancebot#setup-instructions)).
+This can be useful for setting the image size when adding an image using markdown (see the [Image Captions](#image-captions) section for an example), or for adding bulma styles to certain elements (like the warning notification [here](/pages/guides/pydis-guides/contributing/sir-lancebot#run-with-docker)).
**This should be used sparingly, as it reduces readability and simplicity of the article.** --- -- cgit v1.2.3 From d584c7cffac8bff1dfa98a7b22f3fbfabbc73498 Mon Sep 17 00:00:00 2001 From: kosayoda Date: Sun, 11 Dec 2022 11:49:55 -0500 Subject: Kaizen: Ensure consistent formatting and wording. --- .../apps/content/resources/guides/pydis-guides/contributing.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pydis_site/apps/content/resources/guides/pydis-guides/contributing.md b/pydis_site/apps/content/resources/guides/pydis-guides/contributing.md index 2822d046..07e9a7bd 100644 --- a/pydis_site/apps/content/resources/guides/pydis-guides/contributing.md +++ b/pydis_site/apps/content/resources/guides/pydis-guides/contributing.md @@ -112,16 +112,16 @@ You have the source code on your local computer, now how do you actually run it? ### 3. Read our Contributing Guidelines We have a few short rules that all contributors must follow. Make sure you read and follow them while working on our projects. -[**Contributing Guidelines**](./contributing-guidelines/). +[**Read our Contributing Guidelines here.**](./contributing-guidelines/) As mentioned in the Contributing Guidelines, we have a simple style guide for our projects based on PEP 8. Give it a read to keep your code consistent with the rest of the codebase. -[**Style Guide**](./style-guide/) +[**Read our Style Guide here.**](./style-guide/) ### 4. Create an issue The first step to any new contribution is an issue describing a problem with the current codebase or proposing a new feature. All the open issues are viewable on the GitHub repositories, for instance here is the [issues page for Sir Lancebot](https://github.com/python-discord/sir-lancebot/issues). If you have something that you want to implement open a new issue to present your idea. Otherwise, you can browse the unassigned issues and ask to be assigned to one that you're interested in, either in the comments on the issue or in the [`#dev-contrib`](https://discord.gg/2h3qBv8Xaa) channel on Discord. -[**How to write a good issue**](./issues/) +[**Find out how to write a good issue here.**](./issues/) Don't move forward until your issue is approved by a Core Developer. Issues are not guaranteed to be approved so your work may be wasted. {: .notification .is-warning } -- cgit v1.2.3