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

Commit

Permalink
docs(Extensions): Update extension docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nokome committed Feb 19, 2020
1 parent 1124984 commit c871034
Show file tree
Hide file tree
Showing 7 changed files with 13 additions and 7 deletions.
2 changes: 1 addition & 1 deletion src/extensions/cite-apa/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# APA citation style plugin
# APA citation style extension

Provides styling for in-text citations and bibliographies in accordance with the [American Psychological Association (APA) style](https://en.wikipedia.org/wiki/APA_style).
2 changes: 1 addition & 1 deletion src/extensions/cite-mla/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# MLA citation style plugin
# MLA citation style extension

Provides styling for in-text citations and bibliographies in accordance with the [Modern Language Association (MLA) style](https://style.mla.org/).
4 changes: 3 additions & 1 deletion src/extensions/cite/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Citation plugin
# Citation extension

Provides styling for in-text citations (i.e. `Cite` and `CiteGroup` nodes) and bibliographies (i.e. `CreativeWork` nodes in the `references` property of another `CreativeWork`).

This extension acts as a base for other extensions e.g. `cite-apa` that provide styling for a particular citation style.
4 changes: 2 additions & 2 deletions src/extensions/code/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# `CodeFragment` and `CodeBlock` pseudo-components
# Code nodes extension

Syntax highlighting for `CodeFragment` and `CodeBlock` nodes using [Prism](https://prismjs.com/). Will also style executable node types like `CodeExpression` and `CodeChunk` if you do not use the `default` components.
Provides syntax highlighting for `CodeFragment` and `CodeBlock` nodes using [Prism](https://prismjs.com/). Will not style executable node types like `CodeExpression` and `CodeChunk` which are styled by the base Stencila Web Components.

## Notes

Expand Down
2 changes: 1 addition & 1 deletion src/extensions/math/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# `MathFragment` and `MathBlock` pseudo-components
# Math styling extension.

Provides styling of math nodes using MathJax fonts and styles. Use this if there is any likely to be math content, i.e. `MathFragment` and/or `MathBlock` nodes, in documents that your theme targets.

Expand Down
4 changes: 3 additions & 1 deletion src/extensions/person/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# Person component
# Person extension

Provides styling of `Person` nodes e.g the `authors` of an article, or authors for each `citation` in it's `references`.
2 changes: 2 additions & 0 deletions src/extensions/person/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ import { after, create, replace, select, ready } from '../../scripts/dom'
* ```
*/
ready(() => {
// This is a proposal, but due to conflicts with existing styles, is currently
// not enabled.
return
select('[itemtype="http://schema.org/Person"] span[itemprop=name]').forEach(
span => {
Expand Down

0 comments on commit c871034

Please sign in to comment.