privacyguides.org/admonitions.md at main

mirror of https://github.com/privacyguides/privacyguides.org.git synced 2025-07-01 09:12:39 +00:00

Files

redoomed1 06d2f0e3e1 style!: Make minor changes across recommendation pages for consistency (#2972 )

- Grammar, Style, and Wording Changes
  - Remove commas where pauses or breaks in reading may not be needed
  - Reduce instances of comma splices by replacing commas with
    semicolons or em dashes where appropriate
  - Spell out abbreviations like E2EE for the first instance of the term
    on the page, then use the abbreviation for the subsequent instances
  - Add line breaks in card descriptions for a cleaner look,
    particularly for mentions of an accompanying blog review of a tool
  - Move more technical information from recommendation blurb to the
    description under the card
  - Format quotations from audits as block quotes
  - Standardize syntax for tooltips
  - Arrange download links according to the widely used order
    - Mobile app stores > alternative distribution methods (e.g.,
      GitHub) > developer-owned or -operated F-Droid repositories >>
      desktop platforms > Flathub >> browsers >> web
  - Shorten Chrome extension links
  - Standardize icon for web download links
  - For "Repository" buttons, embed direct links to project's Readme to
    differentiate them from "Source Code" links

- Other Changes
  - Add GitHub releases link for IVPN
  - Mention CryptPad's official public instance and add link to list of
    public instances
  - Replace current link to Miniflux docs with a direct link to the end
    user docs
  - Update version of Newsboat documentation link
  - Update and reword guidance on finding YouTube channel code for RSS feed
  - Remove F-Droid download link for Stingle since it is not owned by
    the developer or dev team

Signed-off-by: Jonah Aragon <jonah@privacyguides.org>
Signed-off-by: fria <fria@privacyguides.org>
Signed-off-by: Daniel Gray <dngray@privacyguides.org>

2025-05-15 21:10:42 +09:30

8.6 KiB

Raw Permalink Blame History

title, description

title	description
Admonitions	A guide for website contributors on creating admonitions.

Admonitions (or "call-outs") are tools that writers can use to include side content in an article without interrupting the document flow.

Example Admonition

This is an example of an admonition. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.

Example Collapsible Admonition

This is an example of a collapsible admonition. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.

Formatting

To add an admonition to a page, you can use the following code:

<div class="admonition TYPE" markdown>
<p class="admonition-title">TITLE</p>

ENCLOSED TEXT

</div>

<details class="TYPE" markdown>
<summary>TITLE</summary>

ENCLOSED TEXT

</details>

The TITLE must be specified; if you don't want a specific title you can set it to the same text as the TYPE (see below) in title case, e.g. Note. The ENCLOSED TEXT should be Markdown formatted.