Skip to content

Minor README Tweaks #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 27, 2023
Merged

Minor README Tweaks #32

merged 4 commits into from
Sep 27, 2023

Conversation

RichNSD
Copy link
Contributor

@RichNSD RichNSD commented Sep 27, 2023

Overview

The most significant change I made was to the > **Note** blocks so that they would display using their unique formatting (see Note & Warning Blocks).

I also added a Warning block that informs users they need to setup the AcodeX-Server in order to use AcodeX

The rest of the changes are just slight tweaks to wording and stuff to add clarity.


Note and Warning Blocks

Note and Warning blocks that include a colon :, like what you had originally, won't be formatted correctly.

❌ Incorrect Formatting

Raw Markdown Code:

> **Note:**
> Note block content.

> **Warning:**
> Warning block content.

Output (GitHub):

Note:
Note block content.

Warning:
Warning block content.


✅ Correct Formatting

Raw Markdown Code:

> **Note**
> Note block content.

> **Warning**
> Warning block content.

Output (GitHub):

Note
Note block content.

Warning
Warning block content.

@bajrangCoder
Copy link
Owner

Actually I haven't used Note, Warning etc because that's not supported in acode

@bajrangCoder bajrangCoder merged commit db581c5 into bajrangCoder:main Sep 27, 2023
@RichNSD
Copy link
Contributor Author

RichNSD commented Sep 27, 2023

I know it's not currently supported in Acode's preview, but hopefully it will be eventually lol

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants