Skip to content
This repository has been archived by the owner on Nov 17, 2021. It is now read-only.

Commit

Permalink
docs(README): Fix MD syntax & regenerate HTML
Browse files Browse the repository at this point in the history
  • Loading branch information
alex-ketch committed Feb 27, 2020
1 parent 5039e41 commit 6f79786
Show file tree
Hide file tree
Showing 2 changed files with 173 additions and 119 deletions.
29 changes: 8 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -251,43 +251,30 @@ There are a few key rules enforced by Stylelint:
- reference for crafting your own themes.

To tweak or adjust an existing theme, you may override some common CSS variables found in the themes.

Available CSS variables are:
--color-accent: Color for accent elements, primarily used to add a brand highlights to the theme.
--color-key: Color for body text, and other elements using the inherited body text color.
--color-neutral: Subtle color, usually shades of gray, for element borders and other subtle details.
--color-stock: Article/Page background color, but also used for other elements.
--font-family-body: Font-family for paragraphs and other non-headline elements
--font-family-heading: Font-family for paragraphs and other non-headline elements
--font-family-mono: Font-family for monospaced text elements such as \`pre\` and \`code\`.
--max-width: Max width for textual elements and other non-media content.
--max-width-media: Maximum width for media content, including images and interactive Code Chunks.

Note that not all themes make use of all available variables, and that some may expose additional options.
Please refer to the specific theme documentation.
Please refer to the specific theme documentation for available variables.

Type selectors

For types defined in http://schema.org (e.g. \`Article\`), or extensions such as,
http://schema.stenci.la (e.g. \`CodeChunk\`), http://bioschemas.org (e.g. \`Taxon\`) etc.
For types defined in http://schema.org (e.g. `Article`), or extensions such as,
http://schema.stenci.la (e.g. `CodeChunk`), http://bioschemas.org (e.g. `Taxon`) etc.

Conventions:

- use the same upper camel case as in the schema the type is defined in
- use a \`[itemtype=...]\` selector if possible (i.e. if Encoda encodes it in HTML)
- use a `[itemtype=...]` selector if possible (i.e. if Encoda encodes it in HTML)

Property selectors

For properties of types defined in schemas. Note that
some of these select an entire container property e.g. \`authors\` and
some of these select an entire container property e.g. `authors` and
selector for a class, and some select items in those properties
e.g. \`author\` and select for a \`itemprop\`.
e.g. `author` and select for a `itemprop`.

Conventions:

- use the same lower camel case as in the schema the property is defined in
- use a \`.class\` selector for container properties
- use a \`[itemprop=...]\` selector for singular properties, or items of container properties
- use a `.class` selector for container properties
- use a `[itemprop=...]` selector for singular properties, or items of container properties

There are several additional selectors which are not found as the Stencila Schema definitions. These are:

Expand Down
Loading

0 comments on commit 6f79786

Please sign in to comment.