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

Add Quarto #2550

Merged
merged 3 commits into from
Apr 24, 2023
Merged

Add Quarto #2550

merged 3 commits into from
Apr 24, 2023

Conversation

mcanouil
Copy link
Contributor

https://github.com/mcanouil/awesome-quarto#readme

This list is about Quarto®, an open-source scientific and technical publishing system built on Pandoc, allowing several HTML/PDF formats and computations through R/knitr or Jupyter.

PR Reviewed:

Mentionned in #2242: #2242 (comment)

By submitting this pull request I confirm I've read and complied with the below requirements 🖖

Requirements for your pull request

  • Don't open a Draft / WIP pull request while you work on the guidelines. A pull request should be 100% ready and should adhere to all the guidelines when you open it. Instead use #2242 for incubation visibility.
  • Don't waste my time. Do a good job, adhere to all the guidelines, and be responsive.
  • You have to review at least 2 other open pull requests.
    Try to prioritize unreviewed PRs, but you can also add more comments to reviewed PRs. Go through the below list when reviewing. This requirement is meant to help make the Awesome project self-sustaining. Comment here which PRs you reviewed. You're expected to put a good effort into this and to be thorough. Look at previous PR reviews for inspiration. Just commenting “looks good” or simply marking the pull request as approved does not count! You have to actually point out mistakes or improvement suggestions. Comments pointing out lint violation are allowed, but does not count as a review.
  • You have read and understood the instructions for creating a list.
  • This pull request has a title in the format Add Name of List. It should not contain the word Awesome.
    • Add Swift
    • Add Software Architecture
    • Update readme.md
    • Add Awesome Swift
    • Add swift
    • add Swift
    • Adding Swift
    • Added Swift
  • Your entry here should include a short description about the project/theme of the list. It should not describe the list itself. The first character should be uppercase and the description should end in a dot. It should be an objective description and not a tagline or marketing blurb.
    • - [iOS](…) - Mobile operating system for Apple phones and tablets.
    • - [Framer](…) - Prototyping interactive UI designs.
    • - [iOS](…) - Resources and tools for iOS development.
    • - [Framer](…)
    • - [Framer](…) - prototyping interactive UI designs
  • Your entry should be added at the bottom of the appropriate category.
  • The title of your entry should be title-cased and the URL to your list should end in #readme.
    • Example: - [Software Architecture](https://github.com/simskij/awesome-software-architecture#readme) - The discipline of designing and building software.
  • The suggested Awesome list complies with the below requirements.

Requirements for your Awesome list

  • Has been around for at least 30 days.
    That means 30 days from either the first real commit or when it was open-sourced. Whatever is most recent.
  • Run awesome-lint on your list and fix the reported issues. If there are false-positives or things that cannot/shouldn't be fixed, please report it.
  • The default branch should be named main, not master.
  • Includes a succinct description of the project/theme at the top of the readme. (Example)
    • Mobile operating system for Apple phones and tablets.
    • Prototyping interactive UI designs.
    • Resources and tools for iOS development.
    • Awesome Framer packages and tools.
  • It's the result of hard work and the best I could possibly produce.
    If you have not put in considerable effort into your list, your pull request will be immediately closed.
  • The repo name of your list should be in lowercase slug format: awesome-name-of-list.
    • awesome-swift
    • awesome-web-typography
    • awesome-Swift
    • AwesomeWebTypography
  • The heading title of your list should be in title case format: # Awesome Name of List.
    • # Awesome Swift
    • # Awesome Web Typography
    • # awesome-swift
    • # AwesomeSwift
  • Non-generated Markdown file in a GitHub repo.
  • The repo should have awesome-list & awesome as GitHub topics. I encourage you to add more relevant topics.
  • Not a duplicate. Please search for existing submissions.
  • Only has awesome items. Awesome lists are curations of the best, not everything.
  • Does not contain items that are unmaintained, has archived repo, deprecated, or missing docs. If you really need to include such items, they should be in a separate Markdown file.
  • Includes a project logo/illustration whenever possible.
    • Either centered, fullwidth, or placed at the top-right of the readme. (Example)
    • The image should link to the project website or any relevant website.
    • The image should be high-DPI. Set it to maximum half the width of the original image.
  • Entries have a description, unless the title is descriptive enough by itself. It rarely is though.
  • Includes the Awesome badge.
    • Should be placed on the right side of the readme heading.
      • Can be placed centered if the list has a centered graphics header.
    • Should link back to this list.
  • Has a Table of Contents section.
    • Should be named Contents, not Table of Contents.
    • Should be the first section in the list.
    • Should only have one level of nested lists, preferably none.
    • Must not feature Contributing or Footnotes sections.
  • Has an appropriate license.
    • We strongly recommend the CC0 license, but any Creative Commons license will work.
      • Tip: You can quickly add it to your repo by going to this URL: https://github.com/<user>/<repo>/community/license/new?branch=main&template=cc0-1.0 (replace <user> and <repo> accordingly).
    • A code license like MIT, BSD, Apache, GPL, etc, is not acceptable. Neither are WTFPL and Unlicense.
    • Place a file named license or LICENSE in the repo root with the license text.
    • Do not add the license name, text, or a Licence section to the readme. GitHub already shows the license name and link to the full text at the top of the repo.
    • To verify that you've read all the guidelines, please comment on your pull request with just the word unicorn.
  • Has contribution guidelines.
    • The file should be named contributing.md. Casing is up to you.
    • It can optionally be linked from the readme in a dedicated section titled Contributing, positioned at the top or bottom of the main content.
    • The section should not appear in the Table of Contents.
  • All non-important but necessary content (like extra copyright notices, hyperlinks to sources, pointers to expansive content, etc) should be grouped in a Footnotes section at the bottom of the readme. The section should not be present in the Table of Contents.
  • Has consistent formatting and proper spelling/grammar.
    • The link and description are separated by a dash.
      Example: - [AVA](…) - JavaScript test runner.
    • The description starts with an uppercase character and ends with a period.
    • Consistent and correct naming. For example, Node.js, not NodeJS or node.js.
  • Does not use hard-wrapping.
  • Does not include a CI (e.g. GitHub Actions) badge.
    You can still use a CI for linting, but the badge has no value in the readme.
  • Does not include an Inspired by awesome-foo or Inspired by the Awesome project kinda link at the top of the readme. The Awesome badge is enough.

Go to the top and read it again.

@sellisd
Copy link
Contributor

sellisd commented Mar 13, 2023

Great list! In the library section, entry quartostamp, there is a typo, "An R package An R package"

@mcanouil
Copy link
Contributor Author

@sellisd Thanks for spotting the typo (fixed in mcanouil/awesome-quarto@129a392)

readme.md Outdated Show resolved Hide resolved
@alenrajsp
Copy link

I believe there are a few grammatical improvements possible:

  • Real life examples -> should be Real-life (see, because it is used before a noun as an adjective.
  • Author with scientific markdown, including equations, citations, crossrefs, figure panels, callouts, advanced layout, and more.
    Contributions of any kind are (missing) welcome

@sindresorhus
Copy link
Owner

It looks weird to have both the logo and the title with the same text "awesome quarto". It's enough with just the logo.

@sindresorhus
Copy link
Owner

This looks messy:

Screenshot 2023-04-24 at 02 23 00

@mcanouil
Copy link
Contributor Author

It looks weird to have both the logo and the title with the same text "awesome quarto". It's enough with just the logo.

Not sure to follow the issue here. Logo can't have the title of the list in it?
Using the image as the title is kind of against the guidelines and will make things messier since the badge has to be next to the "title".
What are you suggesting?

@mcanouil
Copy link
Contributor Author

This looks messy:

Screenshot 2023-04-24 at 02 23 00

I can remove it, I don't think it is necessary, especially since it's nearly all (and almost as is) in https://quarto.org/ website.
image

@sindresorhus
Copy link
Owner

I can remove it, I don't think it is necessary, especially since it's nearly all (and almost as is) in https://quarto.org/ website.

I'm not asking you to remove it. Just format it better. It looks very messy when it's centered.

@sindresorhus
Copy link
Owner

Using the image as the title is kind of against the guidelines and will make things messier since the badge has to be next to the "title".

It is not:

Can be placed centered if the list has a centered graphics header.

@mcanouil
Copy link
Contributor Author

Ok, does this seem better?
image

source: https://github.com/mcanouil/awesome-quarto/tree/chore/update-readme-header

@mcanouil
Copy link
Contributor Author

mcanouil commented Apr 23, 2023

I can remove it, I don't think it is necessary, especially since it's nearly all (and almost as is) in https://quarto.org/ website.

I'm not asking you to remove it. Just format it better. It looks very messy when it's centered.

Well, I decided to remove it, I felt it was actually not necessary to have the bullet list since I linked to the website which have a way more extensive description.

@sindresorhus
Copy link
Owner

Ok, does this seem better?

👍

@mcanouil
Copy link
Contributor Author

I merged the new readme. 😉

@sindresorhus sindresorhus merged commit fe3210d into sindresorhus:main Apr 24, 2023
@sindresorhus
Copy link
Owner

Tweet: https://twitter.com/awesome__re/status/1650586331083583488

@mcanouil mcanouil deleted the feat/add-quarto branch April 24, 2023 19:45
@Simeon221
Copy link

091eefb

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.

6 participants