Skip to content

Commit

Permalink
Updates to style guide
Browse files Browse the repository at this point in the history
  • Loading branch information
bernhold committed Oct 13, 2023
1 parent 30c7ff8 commit 8972f6e
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,17 +23,18 @@ Plan: move into production at https://ideas-productivity.org/ in November 2023
* This site represents the entire IDEAS family of projects and spin-offs. All content should reflect this (e.g., connections are encouraged, writing as if the project or activity is completely separate from anything else is discouraged).
* We prefer shorter "light-read" content to longer content and more formal language. The website is not a technical paper -- pasting content from a paper is probably not desirable.
* Longer-form content is okay if this is the only place that it appears. Consider shorter content that links to outside resources. Longer-form content is more likely to appear further down the website hierarchy (for example on a sub-page of an activity rather than the activity's main page)
* Try to avoid significant content on a topic appearing in multiple places on the site. If there is a page with the "meat" of the topic, other mentions can be shorter and point to the meat
* Cross-linking within the site is encouraged
* External links are encouraged, but we have a strong preference for persistent identifiers (e.g., DOI links) and links that we expect to be durable
* Language and styling
* We prefer to use standard Markdown markup over HTML unless there is a particular reason
* Page titles and other `title` content should use title case
* Other headings should use sentence case
* We prefer to use H1 as the highest level headings for page content (not H2)
* `blurbs` (an optional element of most pages and include files) used more or less as subtitles should use sentence case and **end with a period**.
* Subtitle `blurbs` should be action-oriented where possible
* `blurbs` (an optional element of most pages and include files) used more or less as subtitles should use sentence case but should *not* end with periods
* Subtitle `blurbs` should active "-ing" words where possible
* Use subtitle `blurbs` only where they make sense -- they're *optional*
* `blurbs` for `text-biglink.html` includes should be all lowercase, except for acronyms
* `blurbs` for `text-biglink.html` includes should be all lowercase, except for acronyms or key phrases
* For project names that start with "IDEAS", use a hyphen to link to a distinguishing term. For example, IDEAS-Classic, IDEAS-ECP, or IDEAS-Watersheds rather than IDEAS Classic, IDEAS ECP, or IDEAS Watersheds
* Graphics
* Graphics with a transparent background are generally preferred wherever possible. This means PNG or GIF format. JPEG files do not support transparent backgrounds
Expand Down

0 comments on commit 8972f6e

Please sign in to comment.