Skip to content

Commit

Permalink
Revert Github specific markdown to maintain portability
Browse files Browse the repository at this point in the history
  • Loading branch information
edwilde committed Sep 21, 2023
1 parent 215fadf commit eeb4546
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -230,9 +230,9 @@ To customise existing block templates such as `Content` and `Form` templates, co
`vendor/dnadesign/silverstripe-elemental/templates` to your theme. When doing this, ensure you match the folder
structure (PHP class namespace) to ensure that your new template version takes priority.

> [!NOTE]
> The default set of elements follow the [BEM (Block Element Modifier])(http://getbem.com/) class naming convention, which allows developers to style individual parts of the DOM without unnecessarily nested CSS.
> Where possible, we encourage you to follow this naming system.
**Note:** The default set of elements follow the [BEM (Block Element Modifier])(http://getbem.com/) class naming
convention, which allows developers to style individual parts of the DOM without unnecessarily nested CSS. Where
possible, we encourage you to follow this naming system.

#### Position Helpers

Expand Down Expand Up @@ -287,9 +287,10 @@ this index in your search engine to ensure that a page's elemental area content

For information on configuring Solr please see [the fulltextsearch documentation](https://github.com/silverstripe/silverstripe-fulltextsearch).

> [!WARNING]
> If using this indexer, be aware that HTML tags will be stripped from the content before it is indexed.
> The Solr search results may add in emphasis tags or other formatting around matched key words, so you may need to allow unescaped HTML in your search results template. You should use the `$Excerpt` property (see `SolrIndex::search` for more) to display the relevant search matches.
**Note:** If using this indexer, be aware that HTML tags will be stripped from the content before it is indexed.
The Solr search results may add in emphasis tags or other formatting around matched key words, so you may need
to allow unescaped HTML in your search results template. You should use the `$Excerpt` property (see
`SolrIndex::search` for more) to display the relevant search matches.

### Disabling CMS content search

Expand Down Expand Up @@ -332,8 +333,8 @@ yarn build
You'll need to have [yarn installed](https://yarnpkg.com/en/docs/install)
globally in your command line.

> [!NOTE]
> If adding or modifying colours, spacing, font sizes etc. please try and use an appropriate variable from the silverstripe/admin module if available.
**Note:** If adding or modifying colours, spacing, font sizes etc. please try
and use an appropriate variable from the silverstripe/admin module if available.

## Integration with other modules

Expand Down

0 comments on commit eeb4546

Please sign in to comment.