Skip to content
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

Issue #2 addressed, semantic linefeeds, added guidelines for hyperlinking and sourcing #5

Merged

Conversation

OrangeChannel
Copy link
Collaborator

Addressed #2 and added sections for hyperlinking and archiving websites that are probably not permanent.

@OrangeChannel OrangeChannel changed the title Issue #2 fixed, added guidelines for hyperlinking and sourcing Issue #2 addressed, added guidelines for hyperlinking and sourcing Jan 30, 2019
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated
2. Another list item
...
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤔

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh that looked like an underscore, reverted.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Although, I'm confused, why does Atom render both as the same size and spacing? https://imgur.com/VkrS38q and refer to https://en.wikipedia.org/wiki/Ellipsis / https://blog.apastyle.org/apastyle/2015/05/punctuation-junction-quotation-marks-and-ellipses.html . I have always written papers in APA format so it's just a habit to not use the unicode character here.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
overview/preface.md Outdated Show resolved Hide resolved
overview/requirements.md Show resolved Hide resolved
@OrangeChannel OrangeChannel changed the title Issue #2 addressed, added guidelines for hyperlinking and sourcing Issue #2 addressed, semantic linefeeds, added guidelines for hyperlinking and sourcing Jan 31, 2019
while the text of an ordered item should have two spaces after the `#.`
The text of an unordered item should have one space after the `-`,
while the text of an ordered item
should start four columns after the number.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's still kind of ambiguous for multi-digit numbers, but we specifically have an example for that below, so ┐(°ヮ°)┌.

@FichteFoll FichteFoll merged commit d541a20 into Irrational-Encoding-Wizardry:master Jan 31, 2019
@OrangeChannel
Copy link
Collaborator Author

Adjusted the other docs to fit semantic linefeed standards so Git will stop showing giant red and green blocks, no way to do it the first time though without these blocks.

Just read your comment on the other PR (thanks for the help by the way 👍 ) and I'm wondering: Is this PR fine by those standards then?

  • I split the changes categorically this time into two commits and the PR as whole only deals with the docs under the overview SUMMARY.md header.

@FichteFoll
Copy link
Member

FichteFoll commented Jan 31, 2019

Is this PR fine by those standards then?

No, because in the first commit you also changed the install instructions

Otherwise, yes, this was mostly a stylistic change (like adding semantic linefeeds, a bit of rewording of some section) and adding something to the style guidelines. The commits are generally also well-separated and a commit to "address feedback" from the PR review is fine with me, too.

@OrangeChannel
Copy link
Collaborator Author

Oh yea, that was a weird one, because I thought it was using the term plugin incorrectly. It's meant for better color display (which is not a bad thing) and also the ability to copy the commands line by line. The author of the original left in the $ which should actually be added through CSS via counter-increment if you want it, because this will not be copied. You can change it back to the term format by replace the ```js with ```term, but I'm not sure if those colors are supported on all three themes, or if it overwrites the background.

Also, I think (could be wrong) you have to hide the other copy button if you want to use term's, I'm not sure how to go about that besides in-line.

@OrangeChannel
Copy link
Collaborator Author

https://github.com/CLIUtils/gitbook-plugin-term#block-based-auto-colorization maybe I'm interpreting this wrong though, let me know.

@FichteFoll
Copy link
Member

Iirc the $ was required so the plugin would recognize the line with the command, as I don't exactly see how it would otherwise. And the docs seem to support that, too, and the command was picked up by the regex as well. Did you actually try it out before you removed it?

@OrangeChannel
Copy link
Collaborator Author

I did but now thinking of it, I definitely didn't do it correctly. I hadn't actually set up the book but I was using a plug-in on my editor. I see it now working.

I'll add it back to how it was before, sorry about this one 😞 . Thought I was fixing it.

@FichteFoll
Copy link
Member

FichteFoll commented Feb 1, 2019

I still have a couple tabs open with potentially useful plugins from back then when I set up this repo. Somehow people made a lot of plugins for gitbook.

I should finally go through them at some point.

@OrangeChannel
Copy link
Collaborator Author

Hey, turns out my plug-in wasn't 100% functioning wrong. https://guide.encode.moe/CONTRIBUTING.html checkout the first code box. The copy line is only showing up once but at least it is replacing the default one this time. On firefox, the copy button copies all three commands 🤷‍♀️ .

@OrangeChannel OrangeChannel deleted the overview branch February 2, 2019 04:32
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.

None yet

2 participants